### Setup(String, String, String[]) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with application name, connection string, and module names. ```APIDOC ## Setup(String, String, String[]) ### Description Initializes the XafApplication instance with application name, connection string, and module names. ### Method Method signature ### Parameters - **applicationName** (String) - Required - The name of the application. - **connectionString** (String) - Required - The connection string for the application. - **moduleNames** (String[]) - Required - An array of module names. ### Response None ``` -------------------------------- ### Get Text from PDF Area in VB.NET Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.PdfViewer.PdfViewerControl.GetText%28DevExpress.Pdf.PdfDocumentArea%29 This VB.NET example demonstrates how to get text from a PdfDocumentArea using the GetText method and display it in a TextBox. It also shows how to capture start and end positions. ```VB.NET Dim pdfDocumentArea As PdfDocumentArea = New PdfDocumentArea(args.StartPosition.PageNumber, rect) Me.txtText.Text = Me.pdfView.GetText(pdfDocumentArea) Me.txtPositions.Text = $"Start position: {args.StartPosition.Point.X}, {args.StartPosition.Point.Y} ``` -------------------------------- ### Setup(String, IObjectSpaceProvider, String[], ISecurityStrategyBase) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with connection string, object space provider, module names, and security strategy. ```APIDOC ## Setup(String, IObjectSpaceProvider, String[], ISecurityStrategyBase) ### Description Initializes the XafApplication instance with connection string, object space provider, module names, and security strategy. ### Method Method signature ### Parameters - **connectionString** (String) - Required - The connection string for the application. - **objectSpaceProvider** (IObjectSpaceProvider) - Required - The object space provider. - **moduleNames** (String[]) - Required - An array of module names. - **securityStrategy** (ISecurityStrategyBase) - Required - The security strategy. ### Response None ``` -------------------------------- ### Format Text with BeginUpdateCharacters in C# Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.XtraRichEdit.API.Native.SubDocument.BeginUpdateCharacters%28DevExpress.XtraRichEdit.API.Native.DocumentPosition-System.Int32%29 Use BeginUpdateCharacters to get a CharacterProperties object for modifying text formatting. This example sets the foreground color to orange for the first 7 characters after the start of the document. ```csharp textBoxDocument.AppendText("TextBox Text"); CharacterProperties cp = textBoxDocument.BeginUpdateCharacters(textBoxDocument.Range.Start, 7); cp.ForeColor = System.Drawing.Color.Orange; ``` ```csharp textBoxDocument.AppendText("TextBox Text"); CharacterProperties cp = textBoxDocument.BeginUpdateCharacters(textBoxDocument.Range.Start, 7); cp.ForeColor = System.Drawing.Color.Orange; ``` ```csharp // Format the boxed text. CharacterProperties cp = textBoxDocument.BeginUpdateCharacters(textBoxDocument.Range.Start, 7); cp.ForeColor = System.Drawing.Color.Orange; ``` -------------------------------- ### Setup(String, IObjectSpaceProvider) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with connection string and object space provider. ```APIDOC ## Setup(String, IObjectSpaceProvider) ### Description Initializes the XafApplication instance with connection string and object space provider. ### Method Method signature ### Parameters - **connectionString** (String) - Required - The connection string for the application. - **objectSpaceProvider** (IObjectSpaceProvider) - Required - The object space provider. ### Response None ``` -------------------------------- ### Tree List Controller for Getting Started Example Source: https://docs.devexpress.com/AspNetCore/400818/devextreme-based-controls/controls/tree-list Provides a sample ASP.NET Core controller action that prepares a list of Employee objects to be used as a data source for the Tree List component. This demonstrates how to populate the model for the view. ```csharp using System; using System.Collections.Generic; using Microsoft.AspNetCore.Mvc; using ASP.NET_Core.Models.TreeList; namespace ASP_NET_Core.Controllers { public class TreeListController : Controller { public IActionResult GettingStarted() { var model = new List() { new Employee { ID = 1, Head_ID = -1, Full_Name = "John Heart", Title = "CEO", City = "Los Angeles" }, new Employee { ID = 2, Head_ID = 1, Full_Name = "Samantha Bright", Title = "COO", City = "Los Angeles" }, new Employee { ID = 3, Head_ID = 1, Full_Name = "Arthur Miller", Title = "CTO", City = "Denver" }, new Employee { ID = 4, Head_ID = 2, Full_Name = "Greta Sims", Title = "HR Manager", City = "Atlanta" }, new Employee { ID = 5, Head_ID = 2, Full_Name = "Brett Wade", Title = "IT Manager", City = "Reno" }, }; return View(model); } } } ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup() ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters None ### Response None. ``` -------------------------------- ### Start Class Related GitHub Examples Source: https://docs.devexpress.com/CoreLibraries/DevExpress.Diagram.Core.Shapes.Start Code snippets from GitHub examples that reference the Start class, illustrating its usage in XAML for custom shape templates. ```APIDOC ## #Related GitHub Examples The following code snippets (auto-collected from DevExpress Examples) contain references to the **Start** class. Note The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue. * XAML wpf-diagram-create-custom-diagram-containers/CS/DXDiagram.CreateCustomContainers/CustomContainers.xaml#L10 ``` Style="ShapeId.Moderate5"> ``` diagramcontrol-how-to-create-custom-shapes-with-connection-points-using-xaml-markup-t381372/CS/XtraDiagram.CreateCustomShapesXaml/DiagramResources.xaml#L7 ``` ``` wpf-diagramdesigner-create-custom-shapes-with-connection-points/CS/DXDiagram.CreateCustomShapes/CustomShapes.xaml#L6 ``` ``` diagram-register-factoryitemtools-for-shapes/CS/WpfApp13/CustomShapes.xaml#L6 ``` ``` diagram-use-custom-functions-in-shape-templates/CS/WpfApp13/CustomShapes.xaml#L7 ``` ``` ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(ExpressApplicationSetupParameters) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **parameters** (ExpressApplicationSetupParameters) - The setup parameters for the application. ### Response None. ``` -------------------------------- ### Usage Example Source: https://docs.devexpress.com/CoreLibraries/DevExpress.XtraScheduler.RecurrenceInfo.GetDescription%28DevExpress.XtraScheduler.Appointment-System.DayOfWeek%29 Example of how to use the GetDescription method to get a human-readable recurrence pattern description. ```APIDOC ## C# Example ```csharp var infos = new List(); infos.Add(new Info { Name = "Description", Value = RecurrenceInfo.GetDescription(appointment, culture.DateTimeFormat.FirstDayOfWeek) }); infos.Add(new Info { Name = "Next start", Value = GetNextDateDisplayText(appointment) }); ``` ## VB.NET Example ```vb.net .Name = "Description", _ .Value = RecurrenceInfo.GetDescription(appointment, culture.DateTimeFormat.FirstDayOfWeek) _ }) ``` ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(String, IObjectSpaceProvider, ApplicationModulesManager, ISecurityStrategyBase) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **applicationName** (String) - The name of the application. - **objectSpaceProvider** (IObjectSpaceProvider) - The object space provider to use. - **modulesManager** (ApplicationModulesManager) - The application modules manager. - **securityStrategy** (ISecurityStrategyBase) - The security strategy to use. ### Response None. ``` -------------------------------- ### Start Nginx Service Source: https://docs.devexpress.com/eXpressAppFramework/404717/deployment/asp-net-core-blazor/deploy-net-core-application-to-linux-with-nginx Starts the Nginx web server. This command is typically run after Nginx installation. ```bash sudo service nginx start ``` -------------------------------- ### Example Usage Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.Spreadsheet.RowCollection.CollapseGroups%28System.Int32%29 Example of how to use the CollapseGroups method to collapse row groups starting from the second level. ```APIDOC ## Example ```csharp // Collapses all row groups starting from the second level. worksheet.Rows.CollapseGroups(2); ``` ```vb.net ' Collapses all row groups starting from the second level. worksheet.Rows.CollapseGroups(2) ``` ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(String, IObjectSpaceProvider, String[], ISecurityStrategyBase) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **applicationName** (String) - The name of the application. - **objectSpaceProvider** (IObjectSpaceProvider) - The object space provider to use. - **modulePaths** (String[]) - An array of paths to the application modules. - **securityStrategy** (ISecurityStrategyBase) - The security strategy to use. ### Response None. ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(String, IObjectSpaceProvider) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **applicationName** (String) - The name of the application. - **objectSpaceProvider** (IObjectSpaceProvider) - The object space provider to use. ### Response None. ``` -------------------------------- ### Load Document Example (VB.NET) Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.XtraRichEdit.DocumentSaveOptions.CurrentFileName Example of retrieving the CurrentFileName property to get the document name in VB.NET. ```vbnet Dim documentName As String = richEditControl1.Options.DocumentSaveOptions.CurrentFileName Dim msg As String ``` -------------------------------- ### Load Document Example (C#) Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.XtraRichEdit.DocumentSaveOptions.CurrentFileName Example of retrieving the CurrentFileName property to get the document name in C#. ```csharp string documentName = richEditControl1.Options.DocumentSaveOptions.CurrentFileName; string msg; ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(String, IList, ApplicationModulesManager, ISecurityStrategyBase) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **applicationName** (String) - The name of the application. - **objectSpaceProviders** (IList) - A list of object space providers to use. - **modulesManager** (ApplicationModulesManager) - The application modules manager. - **securityStrategy** (ISecurityStrategyBase) - The security strategy to use. ### Response None. ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Initializes the newly created XafApplication class instance. ```APIDOC ## Setup(String, IList, String[], ISecurityStrategyBase) ### Description Initializes the newly created XafApplication class instance. ### Method Setup ### Parameters - **applicationName** (String) - The name of the application. - **objectSpaceProviders** (IList) - A list of object space providers to use. - **modulePaths** (String[]) - An array of paths to the application modules. - **securityStrategy** (ISecurityStrategyBase) - The security strategy to use. ### Response None. ``` -------------------------------- ### Get or Set Section Line Numbering Start (VB.NET) Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.XtraRichEdit.API.Native.SectionLineNumbering.Start Represents the declaration for the Start property in VB.NET. ```vbnet Property Start As Integer ``` -------------------------------- ### Setup(String, IObjectSpaceProvider, ApplicationModulesManager, ISecurityStrategyBase) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with connection string, object space provider, modules manager, and security strategy. ```APIDOC ## Setup(String, IObjectSpaceProvider, ApplicationModulesManager, ISecurityStrategyBase) ### Description Initializes the XafApplication instance with connection string, object space provider, modules manager, and security strategy. ### Method Method signature ### Parameters - **connectionString** (String) - Required - The connection string for the application. - **objectSpaceProvider** (IObjectSpaceProvider) - Required - The object space provider. - **modulesManager** (ApplicationModulesManager) - Required - The application modules manager. - **securityStrategy** (ISecurityStrategyBase) - Required - The security strategy. ### Response None ``` -------------------------------- ### Get or Set Section Line Numbering Start (C#) Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.XtraRichEdit.API.Native.SectionLineNumbering.Start Represents the declaration for the Start property in C#. ```csharp int Start { get; set; } ``` -------------------------------- ### Example Usage Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.ISplash.SetDisplayText%28System.String%29 This example demonstrates how to use the SetDisplayText method before calling the application's Setup method to customize the splash screen text. It's crucial to call SetDisplayText before Setup to ensure the custom text is displayed. ```APIDOC ## Example Usage ### C# ```csharp static class Program { static void Main() { //.. MySolutionWindowsFormsApplication application = new MySolutionWindowsFormsApplication(); try { application.SplashScreen.SetDisplayText("MyText"); application.Setup(); application.Start(); } //... } } ``` **Note:** The `SetDisplayText` method must be called before the `Setup` method call. Otherwise, the splash screen with the default text will be shown. ``` -------------------------------- ### Setup(ExpressApplicationSetupParameters) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the newly created XafApplication class instance with specific setup parameters. ```APIDOC ## Setup(ExpressApplicationSetupParameters) ### Description Initializes the newly created XafApplication class instance with specific setup parameters. ### Method Method signature ### Parameters - **setupParameters** (ExpressApplicationSetupParameters) - Required - The parameters for application setup. ### Response None ``` -------------------------------- ### Setup(String, IList, String[], ISecurityStrategyBase) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with connection string, multiple object space providers, module names, and security strategy. ```APIDOC ## Setup(String, IList, String[], ISecurityStrategyBase) ### Description Initializes the XafApplication instance with connection string, multiple object space providers, module names, and security strategy. ### Method Method signature ### Parameters - **connectionString** (String) - Required - The connection string for the application. - **objectSpaceProviders** (IList) - Required - A list of object space providers. - **moduleNames** (String[]) - Required - An array of module names. - **securityStrategy** (ISecurityStrategyBase) - Required - The security strategy. ### Response None ``` -------------------------------- ### Getting and Setting ClearButtonDisplayMode Source: https://docs.devexpress.com/Blazor/DevExpress.Blazor.ITextEditSettings.ClearButtonDisplayMode Examples of how to get and set the ClearButtonDisplayMode property for text editors using the ITextEditSettings interface. ```APIDOC ## Usage Examples ### Getting Editor Settings and Modifying ClearButtonDisplayMode This example demonstrates how to retrieve the edit settings for a specific column and modify its `ClearButtonDisplayMode`. ```csharp // Assuming 'e' is an event argument object that provides access to the grid var firstNameEditSettings = e.Grid.GetColumnEditSettings("FirstName"); // Alternatively, you can cast to a more specific interface if known: // var firstNameEditSettings = e.Grid.GetColumnEditSettings("FirstName"); if(firstNameEditSettings != null) { e.Grid.BeginUpdate(); firstNameEditSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto; e.Grid.EndUpdate(); } ``` ### Customizing ClearButtonDisplayMode in the Filter Row Handle the `CustomizeFilterRowEditor` event to set the `ClearButtonDisplayMode` for editors in the filter row. ```csharp void Grid_CustomizeFilterRowEditor(GridCustomizeFilterRowEditorEventArgs e) { if(e.EditSettings is ITextEditSettings firstNameEditSettings) // or if(e.EditSettings is ITextBoxSettings firstNameEditSettings) firstNameEditSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto; } ``` ### Customizing ClearButtonDisplayMode in a Data Row Handle the `CustomizeDataRowEditor` event to set the `ClearButtonDisplayMode` for editors in data rows. ```csharp void Grid_CustomizeDataRowEditor(GridCustomizeDataRowEditorEventArgs e) { if(e.EditSettings is ITextEditSettings firstNameEditSettings) // or if(e.EditSettings is ITextBoxSettings firstNameEditSettings) firstNameEditSettings.ClearButtonDisplayMode = DataEditorClearButtonDisplayMode.Auto; } ``` ``` -------------------------------- ### Example Usage of CalcHitInfo Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.Map.MapControl.CalcHitInfo%28System.Windows.Point%29 This example demonstrates how to use the CalcHitInfo method to get a MapShape object from a click event. ```APIDOC ## Example Usage This example shows how to use the `MapControl.CalcHitInfo` method to determine which map shape is located at the specified point. ### C# Example ```csharp MapShape shape = mapControl.CalcHitInfo(e.GetPosition(mapControl)).MapPath as MapShape; ``` ### VB.NET Example ```vb.net Dim shape As MapShape = TryCast(mapControl.CalcHitInfo(e.GetPosition(mapControl)).MapPath, MapShape) ``` ``` -------------------------------- ### Setup Method Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Editors.IComplexViewItem._methods The Setup method is called to pass the XafApplication and IObjectSpace objects to the current IComplexViewItem. ```APIDOC ## Setup ### Description Passes the XafApplication and IObjectSpace objects to the current IComplexViewItem. ### Method Signature Setup(IObjectSpace objectSpace, XafApplication application) ``` -------------------------------- ### Program Entry Point Source: https://docs.devexpress.com/WindowsForms/114966/controls-and-libraries/map-control/examples/vector-data/providing-data/how-to-implement-a-custom-clusterer Sets up the application environment and starts the main form for the custom clusterer sample. ```vbnet Imports System Imports System.Collections.Generic Imports System.Linq Imports System.Threading.Tasks Imports System.Windows.Forms Namespace CustomClustererSample Friend NotInheritable Class Program Private Sub New() End Sub ''' ''' The main entry point for the application. ''' Shared Sub Main() Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) Application.Run(New Form1()) End Sub End Class End Namespace ``` -------------------------------- ### SearchPanelFindMode Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.Grid.DataViewBase._properties Gets or sets whether data searching starts automatically, or must be started manually. This is a dependency property. ```APIDOC ## SearchPanelFindMode ### Description Gets or sets whether data searching starts automatically, or must be started manually. ### Property Type Dependency Property ``` -------------------------------- ### Setup(String, String, String[], ISecurityStrategyBase) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with application name, connection string, module names, and security strategy. ```APIDOC ## Setup(String, String, String[], ISecurityStrategyBase) ### Description Initializes the XafApplication instance with application name, connection string, module names, and security strategy. ### Method Method signature ### Parameters - **applicationName** (String) - Required - The name of the application. - **connectionString** (String) - Required - The connection string for the application. - **moduleNames** (String[]) - Required - An array of module names. - **securityStrategy** (ISecurityStrategyBase) - Required - The security strategy. ### Response None ``` -------------------------------- ### Get Bookmark Start Position Source: https://docs.devexpress.com/AspNet/js-Bookmark.start Retrieves the starting position of a bookmark. This property returns a number representing the position. ```typescript get start(): number ``` -------------------------------- ### Starts With Operator Example Source: https://docs.devexpress.com/WindowsForms/2567/controls-and-libraries/data-grid/filter-and-search/advanced-filter-and-search-concepts Use the Starts With operator to select data field values that begin with a specific substring. ```Criteria Language StartsWith([ShipCountry], ‘G’) ``` -------------------------------- ### Example: Declaring and Initializing SQL Connection Source: https://docs.devexpress.com/CodeRushForRoslyn/116554/coding-assistance/custom-template-creation/using-variables This example demonstrates defining a sub-template for SQL connection declaration and initialization, then using it with variables. ```text #region SQL Connection using System.Data.SqlClient; namespace YourNamespace { public class YourClass { public void YourMethod() { // TODO: Add code here } } } #endregion #region SQL Connection Initialization using (SqlConnection connection = new SqlConnection(@"Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;")) { connection.Open(); // TODO: Add code here } #endregion ``` -------------------------------- ### Setup(String, IList, ApplicationModulesManager, ISecurityStrategyBase) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.XafApplication._members Initializes the XafApplication instance with connection string, multiple object space providers, modules manager, and security strategy. ```APIDOC ## Setup(String, IList, ApplicationModulesManager, ISecurityStrategyBase) ### Description Initializes the XafApplication instance with connection string, multiple object space providers, modules manager, and security strategy. ### Method Method signature ### Parameters - **connectionString** (String) - Required - The connection string for the application. - **objectSpaceProviders** (IList) - Required - A list of object space providers. - **modulesManager** (ApplicationModulesManager) - Required - The application modules manager. - **securityStrategy** (ISecurityStrategyBase) - Required - The security strategy. ### Response None ``` -------------------------------- ### Get Description Column (VB.NET) Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.Views.WinExplorer.WinExplorerView.GetColumn%28DevExpress.XtraGrid.Views.WinExplorer.WinExplorerViewFieldType%29 Example of how to get the column assigned to the Description field using the GetColumn method in VB.NET. ```vbnet winExplorerView1.GetColumn(WinExplorerViewFieldType.Description) ``` -------------------------------- ### Get Description Column (C#) Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.Views.WinExplorer.WinExplorerView.GetColumn%28DevExpress.XtraGrid.Views.WinExplorer.WinExplorerViewFieldType%29 Example of how to get the column assigned to the Description field using the GetColumn method in C#. ```csharp winExplorerView1.GetColumn(WinExplorerViewFieldType.Description); ``` -------------------------------- ### IComplexListEditor.Setup Method Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Editors.IComplexListEditor.Setup%28DevExpress.ExpressApp.CollectionSourceBase-DevExpress.ExpressApp.XafApplication%29 The Setup method is called by the XAF framework to initialize the complex list editor with a CollectionSourceBase and the application instance. This method is crucial for binding the editor to the data source and making it operational within the application. ```APIDOC ## Setup(CollectionSourceBase, XafApplication) ### Description Initializes the complex list editor with the provided collection source and application instance. ### Method Signature `void Setup(CollectionSourceBase collectionSource, XafApplication application)` ### Parameters #### Path Parameters - **collectionSource** (CollectionSourceBase) - Required - The data source for the list editor. - **application** (XafApplication) - Required - The XafApplication instance. ### Remarks This method is invoked by the XAF framework during the view initialization process. It is responsible for setting up the internal state of the list editor, including binding it to the data provided by the `collectionSource` and making the `application` instance available for further operations. ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.Editors.GridListEditor._methods Performs additional initialization of the WinColumnsListEditor. ```APIDOC ## Setup ### Description Performs additional initialization of the WinColumnsListEditor. ### Method Signature `Setup(CollectionSourceBase collectionSource, XafApplication application)` ### Parameters #### Path Parameters - **collectionSource** (CollectionSourceBase) - Description: The collection source. - **application** (XafApplication) - Description: The XafApplication instance. ``` -------------------------------- ### Example Usage of FindText Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraPdfViewer.PdfViewer.FindText%28System.String-DevExpress.Pdf.PdfTextSearchParameters-System.Func-System.Int32-System.Boolean-%29 This example demonstrates how to use the FindText method to search for text and terminate the search starting from a specific page. ```APIDOC ## Example Usage ### C# Example ```csharp pdfViewer1.FindText(text, parameters, value => value >= 2); ``` ### VB.NET Example ```vb.net pdfViewer1.FindText(options.Text, parameters, Sub(value) value >= 2) ``` ### Remarks The code snippet shows how to terminate the text search starting from the page 3 (the page index greater than or equal to 2). ``` -------------------------------- ### Main Method Initialization (C#) Source: https://docs.devexpress.com/WindowsForms/401443/common-features/data-binding/bind-to-azure-data Sets up the connection details and the SQL query for data retrieval within the application's main entry point. Ensure to replace placeholder values with your actual credentials. ```csharp static void Main() { ConnectionSettings.SetUp( "your_server_name.database.windows.net", "your_login", "your_password", "your_database_name"); ConnectionSettings.SelectQuery = "SELECT * FROM SalesLT.Product"; //. . . Application.Run(new Main()); } ``` -------------------------------- ### FindDescendants Example Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraEditors.SvgImageItem.FindDescendants%28System.Predicate-DevExpress.XtraEditors.SvgImageItem-%29 This example demonstrates how to use the FindDescendants method to locate a descendant item whose ID starts with a specific string. ```APIDOC ## Example Usage The following code locates the hovered item’s descendant, whose ID starts with the “pressed” sub-string. * C# ```csharp if (svgImageBox1.HoveredItem != null) { SvgImageItem item3 = svgImageBox1.HoveredItem.FindDescendants(i => i.Id != null && i.Id.StartsWith("pressed")).FirstOrDefault(); } ``` * VB.NET ```vb.net If svgImageBox1.HoveredItem IsNot Nothing Then Dim item3 As SvgImageItem = svgImageBox1.HoveredItem.FindDescendants(Function(i) i.Id IsNot Nothing AndAlso i.Id.StartsWith("pressed")).FirstOrDefault() End If ``` ``` -------------------------------- ### Start() Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraEditors.Camera.CameraControl.Start.overloads Starts showing the video stream from the currently used device. This overload does not require any parameters. ```APIDOC ## Start() ### Description Starts showing the video stream from the currently used device. ### Method None (Instance method) ### Parameters None ### Request Example ```csharp cameraControl.Start(); ``` ### Response This method does not return a value. It initiates the video stream. ``` -------------------------------- ### Example Usage of StartArrowheadType Source: https://docs.devexpress.com/OfficeFileAPI/DevExpress.Spreadsheet.ArrowSettings.StartArrowheadType This example demonstrates how to insert a shape connector, configure its arrows, and set the start arrowhead type to Stealth. ```APIDOC ## Example ### C# ```csharp // Insert a shape connector. Shape shapeConnector = worksheet.Shapes.AddConnector(ConnectorType.Curved, 10, 10, 100, 100); // Adjust the connector's outline. shapeConnector.Outline.SetSolidFill(Color.Black); shapeConnector.Outline.Width = 2.5; // Convert the connector's ends into arrows. ConnectorFormat connectorFormat = shapeConnector.ConnectorFormat; connectorFormat.Arrows.StartArrowheadType = ArrowheadType.Stealth; connectorFormat.Arrows.StartArrowheadWidth = ArrowheadSize.Large; connectorFormat.Arrows.StartArrowheadLength = ArrowheadSize.Large; connectorFormat.Arrows.EndArrowheadType = ArrowheadType.Stealth; connectorFormat.Arrows.EndArrowheadWidth = ArrowheadSize.Large; connectorFormat.Arrows.EndArrowheadLength = ArrowheadSize.Large; // Bind the connector to two shapes. connectorFormat.ConnectStartPoint(shape1, 3); connectorFormat.ConnectEndPoint(shape2, 3); ``` ### VB.NET ```vb ' Insert a shape connector. Dim shapeConnector As Shape = worksheet.Shapes.AddConnector(ConnectorType.Curved, 10, 10, 100, 100) ' Adjust the connector's outline. shapeConnector.Outline.SetSolidFill(Color.Black) shapeConnector.Outline.Width = 2.5 ' Convert the connector's ends into arrows. Dim connectorFormat As ConnectorFormat = shapeConnector.ConnectorFormat connectorFormat.Arrows.StartArrowheadType = ArrowheadType.Stealth connectorFormat.Arrows.StartArrowheadWidth = ArrowheadSize.Large connectorFormat.Arrows.StartArrowheadLength = ArrowheadSize.Large connectorFormat.Arrows.EndArrowheadType = ArrowheadType.Stealth connectorFormat.Arrows.EndArrowheadWidth = ArrowheadSize.Large connectorFormat.Arrows.EndArrowheadLength = ArrowheadSize.Large ' Bind the connector to two shapes. connectorFormat.ConnectStartPoint(shape1, 3) connectorFormat.ConnectEndPoint(shape2, 3) ``` ``` -------------------------------- ### Example 1: Get the sum of values from a whole collection Source: https://docs.devexpress.com/CoreLibraries/DevExpress.Data.Filtering.AggregateOperand.Sum%28DevExpress.Data.Filtering.CriteriaOperator%29 Demonstrates how to use AggregateOperand.Sum to get the sum of values from an entire collection. ```APIDOC ## #Example ### #Example 1 Get the sum of values from a whole collection Expression: * LINQ * Typed * String ``` CriteriaOperator.FromLambda(o => o.OrderItems.Sum(oi => oi.ItemPrice)); ``` ``` new AggregateOperand(new OperandProperty(nameof(Order.OrderItems)), new OperandProperty(nameof(OrderItem.ItemPrice)), Aggregate.Sum, null); ``` ``` CriteriaOperator.Parse("OrderItems.Sum(ItemPrice)"); ``` Test Input: Order | OrderItemName | ItemPrice ---|---|--- Order0 | OrderItem1 | 10 | OrderItem2 | 20 The result: 30 ``` -------------------------------- ### BeginInit() Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.Views.Grid.GridView._methods Starts the runtime View initialization. ```APIDOC ## BeginInit() ### Description Starts the runtime View initialization. Inherited from BaseView. ### Method APIDOC ### Endpoint APIDOC ### Parameters APIDOC ### Request Example APIDOC ### Response APIDOC ``` -------------------------------- ### Get Start and End Dates Source: https://docs.devexpress.com/WindowsForms/404685/ui-templates/data-editors/date-range-picker Retrieve the start and end dates of the selected range using the StartDate and EndDate properties of the DateRangePicker. ```csharp DateTime startDate = dateRangePicker1.StartDate; DateTime endDate = dateRangePicker1.EndDate; ``` -------------------------------- ### Perform Startup Actions in Visual Basic (Method 1) Source: https://docs.devexpress.com/WindowsForms/119891/build-an-application/how-to-perform-actions-on-application-startup Configure project properties to use 'Sub Main' as the startup object and manually add the Main procedure to your form class. Insert initialization code before Application.Run. ```vbnet Public Class Form1 Shared Sub Main() Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) Application.Run(New Form1) 'Specify the startup form End Sub End Class ``` ```vbnet Public Class Form1 Shared Sub Main() 'Add your code here DevExpress.XtraEditors.WindowsFormsSettings.ForceDirectXPaint() DevExpress.XtraEditors.WindowsFormsSettings.EnableFormSkins() Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) Application.Run(New Form1) 'Specify the startup form End Sub End Class ``` -------------------------------- ### Setup(XafApplication) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.ModuleBase.Setup.overloads Sets up a module after it has been added to the XafApplication.Modules collection. ```APIDOC ## Setup(XafApplication) ### Description Sets up a module after it has been added to the XafApplication.Modules collection. ### Parameters #### Path Parameters - **application** (XafApplication) - Description not available ``` -------------------------------- ### Example 2: Get the sum of values from a filtered collection Source: https://docs.devexpress.com/CoreLibraries/DevExpress.Data.Filtering.AggregateOperand.Sum%28DevExpress.Data.Filtering.CriteriaOperator%29 Demonstrates how to use AggregateOperand.Sum with a condition to get the sum of values from a filtered collection. ```APIDOC ### #Example 2 Get the sum of values from a filtered collection. Expression: * LINQ * Typed * String ``` CriteriaOperator.FromLambda(o => o.OrderItems.Where(oi => oi.IsAvailable == true).Sum(oi => oi.ItemPrice)); ; ``` ``` new AggregateOperand(new OperandProperty(nameof(Order.OrderItems)), new OperandProperty(nameof(OrderItem.ItemPrice)), Aggregate.Sum, new BinaryOperator(nameof(OrderItem.IsAvailable), true)); ``` ``` CriteriaOperator.Parse("[OrderItems][IsAvailable=True].Sum(ItemPrice)"); ``` Test Input: Order | OrderItemName | ItemPrice | IsAvailable ---|---|---|--- Order0 | OrderItem1 | 10 | False | OrderItem2 | 20 | False | OrderItem2 | 30 | True | OrderItem2 | 40 | True The result: 70 ``` -------------------------------- ### BeginInit() Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.GridControl._members Starts the grid’s runtime initialization. ```APIDOC ## BeginInit() ### Description Starts the grid's runtime initialization. ### Method `BeginInit()` ### Parameters None ### Response None ``` -------------------------------- ### FindMember Usage Example (C#) Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.DC.ITypeInfo.FindMember%28System.String%29 Example of using FindMember to get metadata for a member named 'NewIntField'. Checks if the member exists before proceeding. ```csharp IMemberInfo memberInfo0 = typeInfo1.FindMember("NewIntField"); if (memberInfo0 == null) { ``` -------------------------------- ### Example Usage in MouseDown Event Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.PdfViewer.PdfViewerControl.ConvertPixelToDocumentPosition%28System.Windows.Point%29 This example demonstrates how to use the ConvertPixelToDocumentPosition method to get the page number of a clicked area in the PDF Viewer. ```APIDOC ## Example: Get Clicked Page Number ### Description This code snippet shows how to determine the page number that was clicked within the PdfViewer control. ### Method - **PdfViewer_MouseDown** (event handler) ### Parameters - **sender** (object) - The object that raised the event. - **e** (MouseButtonEventArgs) - Event data. ### Code Example (C#) ```csharp private void PdfViewer_MouseDown(object sender, MouseButtonEventArgs e) { PdfDocumentPosition position = pdfViewer.ConvertPixelToDocumentPosition(e.GetPosition(pdfViewer)); MessageBox.Show(string.Format("You clicked on page {0}", position.PageNumber)); } ``` ### Code Example (VB.NET) ```vb.net Private Sub PdfViewer_MouseDown(ByVal sender As Object, ByVal e As MouseButtonEventArgs) Dim position As PdfDocumentPosition = pdfViewer.ConvertPixelToDocumentPosition(e.GetPosition(pdfViewer)) MessageBox.Show(String.Format("You clicked on page {0}", position.PageNumber)) End Sub ``` ``` -------------------------------- ### BeginInit Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.Views.Tile.TileView._members Begins the runtime initialization of this TileView. ```APIDOC ## BeginInit() ### Description Begins the runtime initialization of this TileView. ### Method TileView.BeginInit() ``` -------------------------------- ### RangeBase.StartValue Property Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.Gauges.RangeBase.StartValue Gets or sets the start position of the range on a scale. The RangeValue object allows setting the start position in absolute or relative units. ```APIDOC ## #Declaration * C# * VB.NET ``` public RangeValue StartValue { get; set; } ``` ``` Public Property StartValue As RangeValue ``` ## #Property Value Type | Description ---|--- RangeValue | A RangeValue object that allows setting the start position of the range in either absolute or relative units. ## #Remarks Use the **StartValue** and RangeBase.EndValue properties to specify the position of the range on a scale. RangeValue is a complex object that allows you to set the **StartValue** and RangeBase.EndValue properties in different units. The RangeValue.RangeValueType property defines how to treat the RangeValue.Value property - as either an absolute value or as a percent. The following XAML illustrates how to set this property for the range on the circular scale: * XAML ``` ``` * XAML ``` ``` * XAML ``` ``` Note that the **StartValue** can be either less than the **EndValue** or greater than **EndValue** - both situations are correct. ``` -------------------------------- ### BeginInit Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Win.WinApplication._members Starts the XafApplication's initialization. Initialization occurs at runtime. ```APIDOC ## BeginInit() ### Description Starts the XafApplication's initialization. Initialization occurs at runtime. ### Method GET ``` -------------------------------- ### Get Document Range Start Position (Delphi) Source: https://docs.devexpress.com/VCL/dxRichEdit.NativeApi.IdxRichEditDocumentRange.Start Use this property to retrieve the starting position of a document range. The returned value is of type IdxRichEditDocumentPosition. ```Delphi property Start: IdxRichEditDocumentPosition read; ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.Validation.Win.ValidationWindowsFormsModule._methods Sets up a module after it has been created. Inherited from ModuleBase. ```APIDOC ## Setup(ApplicationModulesManager) ### Description Sets up a module after it has been created. ### Inherited From ModuleBase ``` ```APIDOC ## Setup(XafApplication) ### Description Sets up the ValidationWindowsFormsModule after it has been added to the XafApplication.Modules collection. ``` -------------------------------- ### WPF MainWindow Setup Source: https://docs.devexpress.com/WPF/116321/mvvm-framework/services/predefined-set/wizardservice Basic setup for a WPF MainWindow, including necessary using directives and the InitializeComponent call. ```C# using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Windows; using System.Windows.Controls; using System.Windows.Data; using System.Windows.Documents; using System.Windows.Input; using System.Windows.Media; using System.Windows.Media.Imaging; using System.Windows.Navigation; using System.Windows.Shapes; namespace VM_DrivenWizard { /// /// Interaction logic for MainWindow.xaml /// public partial class MainWindow : Window { public MainWindow() { InitializeComponent(); } } } ``` -------------------------------- ### GetControlColumn Usage Example (VB.NET) Source: https://docs.devexpress.com/Dashboard/DevExpress.DashboardWin.GridContext.GetControlColumn%28DevExpress.DashboardCommon.GridColumnBase%29 Example of using GetControlColumn to retrieve a GridColumn in VB.NET. This demonstrates how to get the control's column object for further manipulation. ```vbnet If Not String.IsNullOrEmpty(customProperty) Then Dim gridColumn As GridColumn = e.GridContext.GetControlColumn(itemColumn) If gridColumn IsNot Nothing Then ``` -------------------------------- ### BeginInit() Source: https://docs.devexpress.com/XtraReports/DevExpress.XtraReports.UI.XRTable._members Starts the XRTable’s initialization. Initialization occurs at runtime. ```APIDOC ## BeginInit() ### Description Starts the XRTable’s initialization. Initialization occurs at runtime. ### Method `BeginInit()` ``` -------------------------------- ### FirstDayOfWeek Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraScheduler.SchedulerControl._members Gets the day which the **Scheduler Control** ‘s week starts from. ```APIDOC ## FirstDayOfWeek ### Description Gets the day which the **Scheduler Control** ‘s week starts from. ### Property Type DayOfWeek ``` -------------------------------- ### GetNearestCanFocusedColumn Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraGrid.Views.Base.ColumnView.GetRowCellValue.overloads Gets the nearest column that can be focused, starting from the specified column. ```APIDOC ## GetNearestCanFocusedColumn(GridColumn) ### Description Gets the nearest column that can be focused, starting from the specified column. ### Method `GetNearestCanFocusedColumn` ### Parameters #### Path Parameters - **column** (GridColumn) - Required - The starting column. ### Response #### Success Response - **GridColumn** - The nearest focusable column. ``` -------------------------------- ### Setup Source: https://docs.devexpress.com/eXpressAppFramework/DevExpress.ExpressApp.ModuleBase._methods Sets up a module after it has been created or added to the XafApplication.Modules collection. ```APIDOC ## Setup ### Description Sets up a module after it has been created or added to the XafApplication.Modules collection. ### Method `Setup(ApplicationModulesManager)` or `Setup(XafApplication)` ``` -------------------------------- ### BeginInit Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.Core.LoadingDecorator._members Starts the initialization process for this element. ```APIDOC ## BeginInit() ### Description Starts the initialization process for this element. ### Method BeginInit ``` -------------------------------- ### StartPosition Source: https://docs.devexpress.com/WindowsForms/DevExpress.XtraEditors.XtraSaveFileDialog._properties Gets or sets the dialog start position. Inherited from XtraCommonDialog. ```APIDOC ## Property: StartPosition ### Description Gets or sets the dialog start position. ### Type FormStartPosition ``` -------------------------------- ### Section.start Property Source: https://docs.devexpress.com/AspNet/js-Section.start Gets the section’s start position in the document. ```APIDOC ## Section.start Property ### Description Gets the section’s start position in the document. ### Declaration ```typescript get start(): number ``` ### Property Value - **Type**: number - **Description**: The start position. ``` -------------------------------- ### Main Application Entry Point with Database Initialization Source: https://docs.devexpress.com/WindowsForms/118075/controls-and-libraries/diagrams/examples/how-to-handle-diagramcontrol-events-to-save-diagrams-to-a-database-instead-of-a-file-system Sets up the application for visual styles, compatible text rendering, and initializes the Entity Framework connection factory and database initializer for diagram storage. ```vbnet Imports System Imports System.Collections.Generic Imports System.Data.Entity Imports System.Linq Imports System.Windows.Forms Imports DevExpress.Internal Namespace XtraDiagram.CustomDiagramStorage Friend NotInheritable Class Program Private Sub New() End Sub ''' ''' The main entry point for the application. ''' Shared Sub Main() Application.EnableVisualStyles() Application.SetCompatibleTextRenderingDefault(False) DbEngineDetector.PatchConnectionStringsAndConfigureEntityFrameworkDefaultConnectionFactory() Database.SetInitializer(New DiagramStorageInitializer()) Application.Run(New Form1()) End Sub End Class End Namespace ``` -------------------------------- ### BeginInit Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.Grid.GridControl._members Starts the control’s runtime initialization. ```APIDOC ## BeginInit() ### Description Starts the control’s runtime initialization. ### Method BeginInit ### Inherited From DataControlBase ``` -------------------------------- ### FirstDayOfWeek Property Source: https://docs.devexpress.com/AspNet/DevExpress.Web.ASPxScheduler.Reporting.ASPxSchedulerPrintAdapterBase._members Gets or sets the day that starts the scheduler week. ```APIDOC ## FirstDayOfWeek ### Description Gets or sets the day that starts the scheduler week. ### Property Type DayOfWeek ``` -------------------------------- ### BeginInit Source: https://docs.devexpress.com/WPF/DevExpress.Xpf.PivotGrid.PivotGridControl._members Starts the PivotGrid’s runtime initialization. ```APIDOC ## BeginInit() ### Description Starts the PivotGrid’s runtime initialization. ### Method BeginInit ```