commit 2b5f4b5376d7b428eea8c6ad0a8d13e893e4bbac Author: USER002 Date: Wed May 22 16:56:51 2024 +0900 첫 등록 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..36854cc --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.vs diff --git a/BitgetApi.sln b/BitgetApi.sln new file mode 100644 index 0000000..d82c2ac --- /dev/null +++ b/BitgetApi.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.9.34902.65 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BitgetApi", "BitgetApi\BitgetApi.csproj", "{09813A63-9EF4-4D6D-BA41-5F610909BDEC}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {09813A63-9EF4-4D6D-BA41-5F610909BDEC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {09813A63-9EF4-4D6D-BA41-5F610909BDEC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {09813A63-9EF4-4D6D-BA41-5F610909BDEC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {09813A63-9EF4-4D6D-BA41-5F610909BDEC}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {972BA6BA-7DCA-44ED-8B66-E30326A7210A} + EndGlobalSection +EndGlobal diff --git a/BitgetApi/App.config b/BitgetApi/App.config new file mode 100644 index 0000000..56efbc7 --- /dev/null +++ b/BitgetApi/App.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/BitgetApi/BitgetApi.csproj b/BitgetApi/BitgetApi.csproj new file mode 100644 index 0000000..c525670 --- /dev/null +++ b/BitgetApi/BitgetApi.csproj @@ -0,0 +1,115 @@ + + + + + Debug + AnyCPU + {09813A63-9EF4-4D6D-BA41-5F610909BDEC} + WinExe + BitgetApi + BitgetApi + v4.7.2 + 512 + true + true + + + AnyCPU + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + ..\packages\Newtonsoft.Json.13.0.3\lib\net45\Newtonsoft.Json.dll + + + + + + + + + + + + + + + + + + + + + + + + + + Form + + + MainForm.cs + + + + + + + + MainForm.cs + + + + ResXFileCodeGenerator + Resources.Designer.cs + Designer + + + True + Resources.resx + + + + SettingsSingleFileGenerator + Settings.Designer.cs + + + True + Settings.settings + True + + + + + + + + + + + + + \ No newline at end of file diff --git a/BitgetApi/CommonProperty.cs b/BitgetApi/CommonProperty.cs new file mode 100644 index 0000000..0b1efb2 --- /dev/null +++ b/BitgetApi/CommonProperty.cs @@ -0,0 +1,159 @@ +using System; + +using BitgetAPI.Data; +using BitgetAPI.Utils; +using System.Collections.Generic; +using System.ComponentModel; + +namespace BitgetApi +{ + public class CommonProperty : BaseSettings + { + public enum WebConnectionType + { + POST = 0, + GET = 1 + } + + public enum ExchangePlace + { + Upbit = 0, + Bithumb = 1, + Bitget = 2 + } + + // 코인 Payument 타입 + public enum PaymentType + { + KRW = 0, + BTC = 1, + USDT = 2, + } + + // 최신, 가장오래된, None + public enum CandleType + { + None = 0, + Old = 1, + New = 2 + } + + // Bitget FUTURE 코인 타입 + public enum BitgetProductType + { + COIN = 0, + FUTURE = 1, + MARGIN_보류 = 2 + } + + public ExchangePlace selectedChangePlace; + public PaymentType selectedPaymentType; + public BitgetProductType selectedBitgetProductType; + + public List marketInfoList = null; + public List candleDataLists = null; + + /// + /// TODO 업비트 기능 추가 + /// + // 빗썸 Web 요청 타입 + public enum ExchangeWebReqType + { + #region 빗썸 웹 요청 타입 + [Description("/Public/CandleStick")] + BithumbCandleStick = 0, + [Description("/public/ticker")] + BithumbCandleTicker = 1, + [Description("/public/Orderbook")] + BithumbMarket = 2, + #endregion + + #region 업비트 웹 요청 타입 + [Description("UpbitCandle")] + UpbitCandleStick = 10, + [Description("UpbitMarket")] + UpbitMarket = 11, + #endregion + + #region + [Description("BitgetMarketInfo_SPOT")] + BitgetMarket_Spot = 20, + [Description("BitgetMarketInfo_FUTURE")] + BitgetMarket_Future = 21, + [Description("BitgetMCandle_COIN")] + BitgetCandleStick_Coin = 22, + [Description("BitgetMCandle_FUTURE")] + BitgetCandleStick_Future = 23, + #endregion + } + // 시가/고가/종가/저가 + public enum CandlePriceType + { + 시가 = 1, + 고가 = 2, + 저가 = 3, + 종가 = 4 + } + + // 캔들 데이터 (1분) (3분) (5분) (10분) (15분) (30분) (1시간) (4시간) + public enum MCandleTimeType + { + [Description("1m")] + M1 = 1, + [Description("3m")] + M3 = 3, + [Description("5m")] + M5 = 5, + [Description("15m")] + M15 = 15, + [Description("30m")] + M30 = 30, + [Description("1H")] + H1 = 60, + [Description("4H")] + H4 = 240, + [Description("6H")] + H6 = 360, + [Description("12H")] + H12 = 720, + [Description("1D")] + D1 = 1440, + [Description("3D")] + D3 = 4320, + [Description("1W")] + W1 = 10000, + [Description("1M")] + MT1 = 100000 + } + + + #region 업비트 URL + public static string UpbitURL = "https://api.upbit.com/"; + public static string UpbitURL_MarketInfo = "https://api.upbit.com/v1/market/all"; + public static string UpbitURL_MCandleStick = "https://api.upbit.com/v1/candles/minutes/"; + public static string UpbitURL_DCandleStick = "https://api.upbit.com/v1/candles/days"; + public static string UpbitURL_WCandleStick = "https://api.upbit.com/v1/candles/weeks"; + public static string UpbitURL_MTCandleStick = "https://api.upbit.com/v1/candles/months"; + + public static string UpbitURL_Accounts = "https://api.upbit.com/v1/accounts"; + public static string UpbitURL_Ticker = "https://api.upbit.com/v1/ticker"; + public static string UpbitURL_Ticks = "https://api.upbit.com/v1/trades/ticks"; + + public static string UpbitURL_Orders = "https://api.upbit.com/v1/orders"; + public static string UpbitURL_Order = "https://api.upbit.com/v1/order"; + public static string UpbitURL_Orderbook = "https://api.upbit.com/v1/orderbook"; + public static string UpbitURL_OrderChace = "https://api.upbit.com/v1/orders/chance"; + #endregion + + #region Bitget URL + public static string BitgetURL = "https://api.upbit.com/"; + public static string BitgetURL_MarketInfo_COIN = "https://api.bitget.com/api/v2/spot/public/coins"; + public static string BitgetURL_MarketInfo_FUTURE = "https://api.bitget.com/api/v2/mix/market/tickers?productType=USDT-FUTURES"; + + public static string BitgetURL_MarketCandle_Coin = "https://api.bitget.com/api/v2/spot/market/candles?symbol={0}&granularity={1}in&startTime={2}&endTime={3}&limit={4}"; + public static string BitgetURL_MarketCandle_Future = "https://api.bitget.com/api/v2/mix/market/candles?symbol={0}&granularity={1}&limit={2}&productType={3}"; + + + #endregion + } +} diff --git a/BitgetApi/Data/API/BitGet Access APIKey.txt b/BitgetApi/Data/API/BitGet Access APIKey.txt new file mode 100644 index 0000000..e84f0cf --- /dev/null +++ b/BitgetApi/Data/API/BitGet Access APIKey.txt @@ -0,0 +1,7 @@ +Access APIKey +bg_fbf275132203dcdbdca0db1e4b2351bb + +SecretKey +40ad89ac5347b9c3164ddf8b8e1c464038705266b25049a4f21ca12f509603bd + + diff --git a/BitgetApi/Data/CandleData.cs b/BitgetApi/Data/CandleData.cs new file mode 100644 index 0000000..a527277 --- /dev/null +++ b/BitgetApi/Data/CandleData.cs @@ -0,0 +1,43 @@ +using BitgetApi; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace BitgetAPI.Data +{ + + + public class CandleData + { + CommonProperty commonProperty = CommonProperty.Instance; + + public DateTime Argument { get; set; } + public double Low { get; set; } + public double High { get; set; } + public double Open { get; set; } + public double Close { get; set; } + // 기본 통화 거래량 (BTC) + public double Vol_C { get; set; } + // 견적 통화 거래량 USD + public double Vol_USD { get; set; } + // USDT 거래량 + public double Vol_USDT { get; set; } + + public CandleData() { } + + public CandleData(DateTime argument, double low, double high, double open, double close, + double vol_C, double vol_USD, double vol_USDT) + { + this.Argument = argument; + this.Low = low; + this.High = high; + this.Open = open; + this.Close = close; + this.Vol_C = vol_C; + this.Vol_USD = vol_USD; + this.Vol_USDT = vol_USDT; + } + } +} diff --git a/BitgetApi/Data/CandleDataList.cs b/BitgetApi/Data/CandleDataList.cs new file mode 100644 index 0000000..0e50174 --- /dev/null +++ b/BitgetApi/Data/CandleDataList.cs @@ -0,0 +1,20 @@ +using BitgetApi; +using System; +using System.Collections.Generic; + +namespace BitgetAPI.Data +{ + [Serializable] + public class MarketCandleDataList + { + // 코인 종목 + public MarketInfo ConGoodsData { get; set; } = new MarketInfo(); + // 캔들 데이터 (1분) + public Dictionary> candleDataList { get; set; } + = new Dictionary>(); + + //uuid -> 추후 List로 변경 할 수 잇음 + public string Uuid { get; set; } + + } +} \ No newline at end of file diff --git a/BitgetApi/Data/MarketInfo.cs b/BitgetApi/Data/MarketInfo.cs new file mode 100644 index 0000000..0b0352c --- /dev/null +++ b/BitgetApi/Data/MarketInfo.cs @@ -0,0 +1,14 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace BitgetAPI.Data +{ + public class MarketInfo + { + public string ExchangePlace { get; set; } + public string MarketName { get; set; } + } +} diff --git a/BitgetApi/Data/TradeData.cs b/BitgetApi/Data/TradeData.cs new file mode 100644 index 0000000..b2fd7f8 --- /dev/null +++ b/BitgetApi/Data/TradeData.cs @@ -0,0 +1,27 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace BitgetAPI.Data +{ + public class TradeData + { + public string type { get; set; } + public string code { get; set; } + public long timestamp { get; set; } + public string trade_date { get; set; } + public string trade_time { get; set; } + public long trade_timestamp { get; set; } + public double trade_price { get; set; } + public double trade_volume { get; set; } + public string ask_bid { get; set; } + public double prev_closing_price { get; set; } + public string change { get; set; } + public double change_price { get; set; } + public long sequential_id { get; set; } + public string stream_type { get; set; } + } + +} diff --git a/BitgetApi/MainForm.Designer.cs b/BitgetApi/MainForm.Designer.cs new file mode 100644 index 0000000..60a3d49 --- /dev/null +++ b/BitgetApi/MainForm.Designer.cs @@ -0,0 +1,197 @@ +namespace BitgetApi +{ + partial class MainForm + { + /// + /// 필수 디자이너 변수입니다. + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 사용 중인 모든 리소스를 정리합니다. + /// + /// 관리되는 리소스를 삭제해야 하면 true이고, 그렇지 않으면 false입니다. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows Form 디자이너에서 생성한 코드 + + /// + /// 디자이너 지원에 필요한 메서드입니다. + /// 이 메서드의 내용을 코드 편집기로 수정하지 마세요. + /// + private void InitializeComponent() + { + this.groupControl_Setting = new DevExpress.XtraEditors.GroupControl(); + this.comboBoxEdit_ConinType = new DevExpress.XtraEditors.ComboBoxEdit(); + this.comboBoxEdit_ExchangePlace = new DevExpress.XtraEditors.ComboBoxEdit(); + this.labelControl2 = new DevExpress.XtraEditors.LabelControl(); + this.labelControl1 = new DevExpress.XtraEditors.LabelControl(); + this.groupControl_MarketInfo = new DevExpress.XtraEditors.GroupControl(); + this.treeList_MarketInfo = new DevExpress.XtraTreeList.TreeList(); + this.treeListColumn_ExchangePlace = new DevExpress.XtraTreeList.Columns.TreeListColumn(); + this.treeListColumn_MarketName = new DevExpress.XtraTreeList.Columns.TreeListColumn(); + this.labelControl3 = new DevExpress.XtraEditors.LabelControl(); + this.labelControl_MarketCount = new DevExpress.XtraEditors.LabelControl(); + ((System.ComponentModel.ISupportInitialize)(this.groupControl_Setting)).BeginInit(); + this.groupControl_Setting.SuspendLayout(); + ((System.ComponentModel.ISupportInitialize)(this.comboBoxEdit_ConinType.Properties)).BeginInit(); + ((System.ComponentModel.ISupportInitialize)(this.comboBoxEdit_ExchangePlace.Properties)).BeginInit(); + ((System.ComponentModel.ISupportInitialize)(this.groupControl_MarketInfo)).BeginInit(); + this.groupControl_MarketInfo.SuspendLayout(); + ((System.ComponentModel.ISupportInitialize)(this.treeList_MarketInfo)).BeginInit(); + this.SuspendLayout(); + // + // groupControl_Setting + // + this.groupControl_Setting.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.groupControl_Setting.Controls.Add(this.comboBoxEdit_ConinType); + this.groupControl_Setting.Controls.Add(this.comboBoxEdit_ExchangePlace); + this.groupControl_Setting.Controls.Add(this.labelControl2); + this.groupControl_Setting.Controls.Add(this.labelControl1); + this.groupControl_Setting.Location = new System.Drawing.Point(3, 2); + this.groupControl_Setting.Name = "groupControl_Setting"; + this.groupControl_Setting.Size = new System.Drawing.Size(912, 100); + this.groupControl_Setting.TabIndex = 0; + this.groupControl_Setting.Text = "초기 설정"; + // + // comboBoxEdit_ConinType + // + this.comboBoxEdit_ConinType.Location = new System.Drawing.Point(248, 41); + this.comboBoxEdit_ConinType.Name = "comboBoxEdit_ConinType"; + this.comboBoxEdit_ConinType.Properties.Buttons.AddRange(new DevExpress.XtraEditors.Controls.EditorButton[] { + new DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)}); + this.comboBoxEdit_ConinType.Size = new System.Drawing.Size(100, 20); + this.comboBoxEdit_ConinType.TabIndex = 1; + this.comboBoxEdit_ConinType.SelectedIndexChanged += new System.EventHandler(this.comboBox_CoinType_SelectedIndexChanged); + // + // comboBoxEdit_ExchangePlace + // + this.comboBoxEdit_ExchangePlace.Location = new System.Drawing.Point(66, 41); + this.comboBoxEdit_ExchangePlace.Name = "comboBoxEdit_ExchangePlace"; + this.comboBoxEdit_ExchangePlace.Properties.Buttons.AddRange(new DevExpress.XtraEditors.Controls.EditorButton[] { + new DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)}); + this.comboBoxEdit_ExchangePlace.Size = new System.Drawing.Size(100, 20); + this.comboBoxEdit_ExchangePlace.TabIndex = 1; + this.comboBoxEdit_ExchangePlace.SelectedIndexChanged += new System.EventHandler(this.comboBox_ExchangePlace_SelectedIndexChanged); + // + // labelControl2 + // + this.labelControl2.Location = new System.Drawing.Point(186, 44); + this.labelControl2.Name = "labelControl2"; + this.labelControl2.Size = new System.Drawing.Size(56, 14); + this.labelControl2.TabIndex = 0; + this.labelControl2.Text = "코인 타입 : "; + // + // labelControl1 + // + this.labelControl1.Location = new System.Drawing.Point(18, 44); + this.labelControl1.Name = "labelControl1"; + this.labelControl1.Size = new System.Drawing.Size(42, 14); + this.labelControl1.TabIndex = 0; + this.labelControl1.Text = "거래소 : "; + // + // groupControl_MarketInfo + // + this.groupControl_MarketInfo.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.groupControl_MarketInfo.Controls.Add(this.labelControl_MarketCount); + this.groupControl_MarketInfo.Controls.Add(this.labelControl3); + this.groupControl_MarketInfo.Controls.Add(this.treeList_MarketInfo); + this.groupControl_MarketInfo.Location = new System.Drawing.Point(2, 108); + this.groupControl_MarketInfo.Name = "groupControl_MarketInfo"; + this.groupControl_MarketInfo.Size = new System.Drawing.Size(912, 430); + this.groupControl_MarketInfo.TabIndex = 1; + this.groupControl_MarketInfo.Text = "종목 현황"; + // + // treeList_MarketInfo + // + this.treeList_MarketInfo.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.treeList_MarketInfo.Columns.AddRange(new DevExpress.XtraTreeList.Columns.TreeListColumn[] { + this.treeListColumn_ExchangePlace, + this.treeListColumn_MarketName}); + this.treeList_MarketInfo.Location = new System.Drawing.Point(2, 56); + this.treeList_MarketInfo.Name = "treeList_MarketInfo"; + this.treeList_MarketInfo.Size = new System.Drawing.Size(908, 372); + this.treeList_MarketInfo.TabIndex = 0; + // + // treeListColumn_ExchangePlace + // + this.treeListColumn_ExchangePlace.Caption = "거래소"; + this.treeListColumn_ExchangePlace.FieldName = "ExchangePlace"; + this.treeListColumn_ExchangePlace.Name = "treeListColumn_ExchangePlace"; + this.treeListColumn_ExchangePlace.Visible = true; + this.treeListColumn_ExchangePlace.VisibleIndex = 0; + // + // treeListColumn_MarketName + // + this.treeListColumn_MarketName.Caption = "종목"; + this.treeListColumn_MarketName.FieldName = "MarketName"; + this.treeListColumn_MarketName.Name = "treeListColumn_MarketName"; + this.treeListColumn_MarketName.Visible = true; + this.treeListColumn_MarketName.VisibleIndex = 1; + // + // labelControl3 + // + this.labelControl3.Location = new System.Drawing.Point(804, 36); + this.labelControl3.Name = "labelControl3"; + this.labelControl3.Size = new System.Drawing.Size(46, 14); + this.labelControl3.TabIndex = 1; + this.labelControl3.Text = "총 개수 : "; + // + // labelControl_MarketCount + // + this.labelControl_MarketCount.Location = new System.Drawing.Point(856, 36); + this.labelControl_MarketCount.Name = "labelControl_MarketCount"; + this.labelControl_MarketCount.Size = new System.Drawing.Size(21, 14); + this.labelControl_MarketCount.TabIndex = 2; + this.labelControl_MarketCount.Text = "220"; + // + // MainForm + // + this.AutoScaleDimensions = new System.Drawing.SizeF(7F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.ClientSize = new System.Drawing.Size(916, 542); + this.Controls.Add(this.groupControl_MarketInfo); + this.Controls.Add(this.groupControl_Setting); + this.Name = "MainForm"; + this.Text = "Searcher"; + ((System.ComponentModel.ISupportInitialize)(this.groupControl_Setting)).EndInit(); + this.groupControl_Setting.ResumeLayout(false); + this.groupControl_Setting.PerformLayout(); + ((System.ComponentModel.ISupportInitialize)(this.comboBoxEdit_ConinType.Properties)).EndInit(); + ((System.ComponentModel.ISupportInitialize)(this.comboBoxEdit_ExchangePlace.Properties)).EndInit(); + ((System.ComponentModel.ISupportInitialize)(this.groupControl_MarketInfo)).EndInit(); + this.groupControl_MarketInfo.ResumeLayout(false); + this.groupControl_MarketInfo.PerformLayout(); + ((System.ComponentModel.ISupportInitialize)(this.treeList_MarketInfo)).EndInit(); + this.ResumeLayout(false); + + } + + #endregion + + private DevExpress.XtraEditors.GroupControl groupControl_Setting; + private DevExpress.XtraEditors.GroupControl groupControl_MarketInfo; + private DevExpress.XtraTreeList.TreeList treeList_MarketInfo; + private DevExpress.XtraEditors.ComboBoxEdit comboBoxEdit_ConinType; + private DevExpress.XtraEditors.ComboBoxEdit comboBoxEdit_ExchangePlace; + private DevExpress.XtraEditors.LabelControl labelControl2; + private DevExpress.XtraEditors.LabelControl labelControl1; + private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn_ExchangePlace; + private DevExpress.XtraTreeList.Columns.TreeListColumn treeListColumn_MarketName; + private DevExpress.XtraEditors.LabelControl labelControl_MarketCount; + private DevExpress.XtraEditors.LabelControl labelControl3; + } +} + diff --git a/BitgetApi/MainForm.cs b/BitgetApi/MainForm.cs new file mode 100644 index 0000000..95b8ad5 --- /dev/null +++ b/BitgetApi/MainForm.cs @@ -0,0 +1,241 @@ +using BitgetAPI.Data; +using DevExpress.XtraEditors; +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Net.WebSockets; +using System.Reflection; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using System.Windows.Forms; +using static BitgetApi.CommonProperty; + +namespace BitgetApi +{ + public partial class MainForm : Form + { + CommonProperty commonProperty = CommonProperty.Instance; + + public MainForm() + { + InitializeComponent(); + + init(); + } + + // 폼 초기화 작업 + public void init() + { + // 거래소 항목 추가 및 설정하기 + comboBoxEdit_ExchangePlace.Properties.Items.AddRange(Enum.GetNames(typeof(CommonProperty.ExchangePlace))); + comboBoxEdit_ExchangePlace.SelectedIndex = (int)CommonProperty.ExchangePlace.Bitget; + commonProperty.selectedChangePlace = CommonProperty.ExchangePlace.Bitget; + + // API Key 가져오기 및 등록 + + // BITGET Raster 소켓 테스트 + + // 데이터 분석 + + // 캔들 가져오기 + + // 구름떼, 볼린저 생성 + + // + + // + } + + public async void webSocektStart() + { + string apiUrl = "https://api.upbit.com/v1/market/all?isDetails=true"; + + // IP당 100개 연결 + // 시간당 240회 !!! + // 타이머 30초 유지 > 30초 이내의 응답 메시지 수신 필요 > 아니면 오류 발생 !! > 재접속 필요 !! + // 초당 10개 메시지 허용 + // 단일 연결로 최대 1000개의 스트림 구독 + // 단인 IP 최대의 100개 연결 + + // * + /* timestamp : Unix Epoch 시간 + * passphrase : APIKey 비밀번호 + * timestamp : Unix Epoch 시간, 단위는 초(--restAPI의 서명 타임스탬프와 다름--) + * secretKey : 사용자가 APIKey를 신청할 때 생성되는 보안 키입니다. 예: 22582BD0CFF14C41EDBF1AB98506286D + */ + + + ClientWebSocket webSocket = new ClientWebSocket(); + + string WebSocketUrl = "wss://ws.bitget.com/v2/ws/public"; + string message = ""; + + try + { + await webSocket.ConnectAsync(new Uri(WebSocketUrl), CancellationToken.None); + // 연결이 성공적으로 이루어지면 처리할 코드 작성 + Console.WriteLine("WebSocket 연결 성공"); + + var jsonDataText = "{\"op\":\"subscribe\",\"args\":[{\"instType\":\"SPOT\",\"channel\":\"ticker\",\"instId\":\"ETHUSDT\"}, {\"instType\":\"SPOT\",\"channel\":\"ticker\",\"instId\":\"BTCUSDT\"}]}"; + + // test11 = JsonConvert.SerializeObject(jsonData); + + await SendMessage(webSocket, jsonDataText); + + + // 데이터 수신을 위한 반복문 시작 + while (webSocket.State == WebSocketState.Open) + { + byte[] buffer = new byte[1024]; + WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment(buffer), CancellationToken.None); + message = ""; + // 수신한 데이터 처리 + message = System.Text.Encoding.UTF8.GetString(buffer, 0, result.Count); + var testData = JsonConvert.DeserializeObject(message); + + Console.WriteLine("수신한 데이터: " + message); + DateTime dt = new DateTime(1970, 01, 01); + dt = dt.AddMilliseconds(testData.trade_timestamp).ToLocalTime(); + } + } + catch (Exception ex) + { + Console.WriteLine("WebSocket 연결 중 오류 발생: " + ex.Message); + } + finally + { + if (webSocket.State == WebSocketState.Open) + await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, "WebSocket 연결 종료", CancellationToken.None); + + webSocket.Dispose(); + } + } + + private static async Task SendMessage(ClientWebSocket webSocket, string message) + { + byte[] buffer = Encoding.UTF8.GetBytes(message); + await webSocket.SendAsync(new ArraySegment(buffer), WebSocketMessageType.Text, true, CancellationToken.None); + Console.WriteLine("메시지 전송: " + message); + } + + // 거래소 콤보박스 클릭 시 이벤트 처리 + private void comboBox_ExchangePlace_SelectedIndexChanged(object sender, EventArgs e) + { + var combobox = (ComboBoxEdit)sender; + + // 거래소에 따라서 코인 타입 생성하기 + switch (combobox.SelectedIndex) + { + case (int)CommonProperty.ExchangePlace.Bitget: + // 코인 타입 설정하기 + comboBoxEdit_ConinType.Properties.Items.AddRange(Enum.GetNames(typeof(CommonProperty.BitgetProductType))); + comboBoxEdit_ConinType.SelectedIndex = (int)CommonProperty.BitgetProductType.FUTURE; + commonProperty.selectedBitgetProductType = CommonProperty.BitgetProductType.FUTURE; + break; + } + + } + + // 코인 타입 콤보박스 클릭 시 이벤트 처리 + private void comboBox_CoinType_SelectedIndexChanged(object sender, EventArgs e) + { + var combobox = (ComboBoxEdit)sender; + + // 선택된 타입에 따라서 종목 정보 가져오기 + ExchangeWebReqType exchangeWebReqType = ExchangeWebReqType.BitgetMarket_Future; + switch (combobox.SelectedIndex) + { + case (int)CommonProperty.BitgetProductType.COIN: + commonProperty.selectedBitgetProductType = CommonProperty.BitgetProductType.COIN; + exchangeWebReqType = ExchangeWebReqType.BitgetMarket_Spot; + break; + case (int)CommonProperty.BitgetProductType.FUTURE: + commonProperty.selectedBitgetProductType = CommonProperty.BitgetProductType.FUTURE; + exchangeWebReqType = ExchangeWebReqType.BitgetMarket_Future; + break; + case (int)CommonProperty.BitgetProductType.MARGIN_보류: + commonProperty.selectedBitgetProductType = CommonProperty.BitgetProductType.MARGIN_보류; + break; + } + + // 마켓 정보 가져오기 + var marketInfos = (List)BitgetAPI.WebService.WebConnection.SendWebServer(exchangeWebReqType); + + labelControl_MarketCount.Text = marketInfos.Count().ToString(); + treeList_MarketInfo.DataSource = marketInfos; + treeList_MarketInfo.RefreshDataSource(); + + List candleDataLists = new List(); + + commonProperty.candleDataLists = candleDataLists; + + var candleCount = 200; + + // 캔들 데이터 가져오기 : 종목, 개수, + foreach(var item in marketInfos) + { + MarketCandleDataList candleDataList = new MarketCandleDataList(); + candleDataList.ConGoodsData = item; + + // 캔들 데이터 가져오기 + foreach(var interval in Enum.GetValues(typeof(CommonProperty.MCandleTimeType))) + { + // Description + var description = Utils.Convertor.GetEnumDescription((Enum)interval); + // 1M, 3M Names.... + var intervalName = Enum.GetName(typeof(CommonProperty.MCandleTimeType), interval); + + var url = ""; + + switch(commonProperty.selectedChangePlace) + { + case ExchangePlace.Upbit: + break; + case ExchangePlace.Bitget: + switch(commonProperty.selectedBitgetProductType) + { + case BitgetProductType.COIN: + exchangeWebReqType = ExchangeWebReqType.BitgetCandleStick_Coin; + var defaultDateTime = DateTime.Now; + + var startDateTime = DateTime.FromFileTimeUtc(defaultDateTime.Ticks); + + // count + 50 개 캔들 추가 가져오기 + var endDateTime = DateTime.FromFileTimeUtc(defaultDateTime.AddSeconds((int)interval * -1).Ticks); + + // 종목, 인터벌시간, 시작시간(UTC), 종료시간(UTC), 제한 개수 (default:100, Max:1000) + url = string.Format(BitgetURL_MarketCandle_Coin, + item.MarketName, description, startDateTime.ToString(), endDateTime.ToString(), candleCount.ToString()); + break; + case BitgetProductType.FUTURE: + exchangeWebReqType = ExchangeWebReqType.BitgetCandleStick_Future; + + url = string.Format(CommonProperty.BitgetURL_MarketCandle_Future, + item.MarketName, description, candleCount.ToString(), "USDT-FUTURES"); + break; + } + break; + } + + var candleList = BitgetAPI.WebService.WebConnection.SendWebServer(exchangeWebReqType, url); + // 초당 20회 제한 !!!! + // Thread.Sleep(50); + candleDataList.candleDataList.Add((MCandleTimeType)interval,(List)candleList); + + } + + candleDataLists.Add(candleDataList); + } + + var test = ""; + test += "1"; + + + } + } +} diff --git a/BitgetApi/MainForm.resx b/BitgetApi/MainForm.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/BitgetApi/MainForm.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/BitgetApi/Program.cs b/BitgetApi/Program.cs new file mode 100644 index 0000000..6d8189f --- /dev/null +++ b/BitgetApi/Program.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace BitgetApi +{ + internal static class Program + { + /// + /// 해당 애플리케이션의 주 진입점입니다. + /// + [STAThread] + static void Main() + { + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new MainForm()); + } + } +} diff --git a/BitgetApi/Properties/AssemblyInfo.cs b/BitgetApi/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..d50ef1b --- /dev/null +++ b/BitgetApi/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 어셈블리에 대한 일반 정보는 다음 특성 집합을 통해 +// 제어됩니다. 어셈블리와 관련된 정보를 수정하려면 +// 이러한 특성 값을 변경하세요. +[assembly: AssemblyTitle("BitgetApi")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("BitgetApi")] +[assembly: AssemblyCopyright("Copyright © 2024")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// ComVisible을 false로 설정하면 이 어셈블리의 형식이 COM 구성 요소에 +// 표시되지 않습니다. COM에서 이 어셈블리의 형식에 액세스하려면 +// 해당 형식에 대해 ComVisible 특성을 true로 설정하세요. +[assembly: ComVisible(false)] + +// 이 프로젝트가 COM에 노출되는 경우 다음 GUID는 typelib의 ID를 나타냅니다. +[assembly: Guid("09813a63-9ef4-4d6d-ba41-5f610909bdec")] + +// 어셈블리의 버전 정보는 다음 네 가지 값으로 구성됩니다. +// +// 주 버전 +// 부 버전 +// 빌드 번호 +// 수정 버전 +// +// 모든 값을 지정하거나 아래와 같이 '*'를 사용하여 빌드 번호 및 수정 번호를 +// 기본값으로 할 수 있습니다. +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/BitgetApi/Properties/Resources.Designer.cs b/BitgetApi/Properties/Resources.Designer.cs new file mode 100644 index 0000000..ae7d954 --- /dev/null +++ b/BitgetApi/Properties/Resources.Designer.cs @@ -0,0 +1,71 @@ +//------------------------------------------------------------------------------ +// +// 이 코드는 도구를 사용하여 생성되었습니다. +// 런타임 버전:4.0.30319.42000 +// +// 파일 내용을 변경하면 잘못된 동작이 발생할 수 있으며, 코드를 다시 생성하면 +// 이러한 변경 내용이 손실됩니다. +// +//------------------------------------------------------------------------------ + +namespace BitgetApi.Properties +{ + + + /// + /// 지역화된 문자열 등을 찾기 위한 강력한 형식의 리소스 클래스입니다. + /// + // 이 클래스는 ResGen 또는 Visual Studio와 같은 도구를 통해 StronglyTypedResourceBuilder + // 클래스에서 자동으로 생성되었습니다. + // 멤버를 추가하거나 제거하려면 .ResX 파일을 편집한 다음 /str 옵션을 사용하여 + // ResGen을 다시 실행하거나 VS 프로젝트를 다시 빌드하십시오. + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "4.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources + { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() + { + } + + /// + /// 이 클래스에서 사용하는 캐시된 ResourceManager 인스턴스를 반환합니다. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager + { + get + { + if ((resourceMan == null)) + { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("BitgetApi.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// 이 강력한 형식의 리소스 클래스를 사용하여 모든 리소스 조회에 대해 현재 스레드의 CurrentUICulture 속성을 + /// 재정의합니다. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture + { + get + { + return resourceCulture; + } + set + { + resourceCulture = value; + } + } + } +} diff --git a/BitgetApi/Properties/Resources.resx b/BitgetApi/Properties/Resources.resx new file mode 100644 index 0000000..af7dbeb --- /dev/null +++ b/BitgetApi/Properties/Resources.resx @@ -0,0 +1,117 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/BitgetApi/Properties/Settings.Designer.cs b/BitgetApi/Properties/Settings.Designer.cs new file mode 100644 index 0000000..c74bdc7 --- /dev/null +++ b/BitgetApi/Properties/Settings.Designer.cs @@ -0,0 +1,30 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace BitgetApi.Properties +{ + + + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "11.0.0.0")] + internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase + { + + private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); + + public static Settings Default + { + get + { + return defaultInstance; + } + } + } +} diff --git a/BitgetApi/Properties/Settings.settings b/BitgetApi/Properties/Settings.settings new file mode 100644 index 0000000..3964565 --- /dev/null +++ b/BitgetApi/Properties/Settings.settings @@ -0,0 +1,7 @@ + + + + + + + diff --git a/BitgetApi/Properties/licenses.licx b/BitgetApi/Properties/licenses.licx new file mode 100644 index 0000000..9091129 --- /dev/null +++ b/BitgetApi/Properties/licenses.licx @@ -0,0 +1,2 @@ +DevExpress.XtraEditors.ComboBoxEdit, DevExpress.XtraEditors.v23.2, Version=23.2.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a +DevExpress.XtraTreeList.TreeList, DevExpress.XtraTreeList.v23.2, Version=23.2.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a diff --git a/BitgetApi/Utils/BaseSingleton.cs b/BitgetApi/Utils/BaseSingleton.cs new file mode 100644 index 0000000..543eeb4 --- /dev/null +++ b/BitgetApi/Utils/BaseSingleton.cs @@ -0,0 +1,72 @@ +using Newtonsoft.Json; +using System; +using System.IO; + +namespace BitgetAPI.Utils +{ + public class BaseSettings where T : class, new() + { + private static readonly object lockObject = new object(); + private static readonly object fileLockObject = new object(); + private static T _instance; + public static T Instance + { + get + { + lock (lockObject) + { + //var path = GetSettingFilePath(); + + if (null == _instance) + _instance = CreateInstance(); + } + return _instance; + } + } + + protected static T CreateInstance() + { + try + { + Type type = typeof(T); + var saveFilePath = getFilePath(); + + if (File.Exists(saveFilePath)) + { + //File.ReadAllText(saveFilePath); + return JsonConvert.DeserializeObject(File.ReadAllText(saveFilePath)) ?? new T(); + } + } + catch { } + + return new T(); + } + + private static string getFilePath() + { + return typeof(T).Name + ".json"; + } + + ~BaseSettings() + { + SaveConfig(); + } + + public void SaveConfig() + { + lock (fileLockObject) + { + try + { + string json = JsonConvert.SerializeObject(this, Formatting.Indented); + File.WriteAllText(getFilePath(), json); + } + catch + { + + } + } + } + + } +} \ No newline at end of file diff --git a/BitgetApi/Utils/Convertor.cs b/BitgetApi/Utils/Convertor.cs new file mode 100644 index 0000000..6e473c0 --- /dev/null +++ b/BitgetApi/Utils/Convertor.cs @@ -0,0 +1,42 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Reflection; +using System.Text; +using System.Threading.Tasks; + +namespace BitgetApi.Utils +{ + public static class Convertor + { + /// + /// Get Enum Description + /// + /// + /// + public static string GetEnumDescription(Enum source) + { + FieldInfo fi = source.GetType().GetField(source.ToString()); + var att = (DescriptionAttribute)fi.GetCustomAttribute(typeof(DescriptionAttribute)); + if (att != null) + { + return att.Description; + } + else + { + return source.ToString(); + } + } + + public static long GetDateTimeToUnixtimeStamp(DateTime datetime) + { + return (long)(datetime - new DateTime(1970, 1, 1, 9, 0, 0)).TotalSeconds; + } + + public static DateTime GetUnixtimeStampToDateTime(long unixStamptime) + { + return new DateTime(1970, 1, 1, 9, 0, 0).AddMilliseconds(unixStamptime); ; + } + } +} diff --git a/BitgetApi/WebService/WebConnection.cs b/BitgetApi/WebService/WebConnection.cs new file mode 100644 index 0000000..b57c630 --- /dev/null +++ b/BitgetApi/WebService/WebConnection.cs @@ -0,0 +1,170 @@ +using BitgetApi; +using BitgetApi.Utils; +using BitgetAPI.Data; +using BitgetAPI.Utils; +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net; +using System.Text; +using System.Threading.Tasks; + +namespace BitgetAPI.WebService +{ + public class WebConnection + { + public static object SendWebServer(CommonProperty.ExchangeWebReqType exchangeWebReqType, string url = "", string postData = "", string subUri = "") + { + object returnJsonData = null; + + CommonProperty commonProperty = CommonProperty.Instance; + + try + { + HttpWebRequest wReq = null; + + // Post 방식인 경우만 사용 + var rgbyData = Encoding.ASCII.GetBytes(postData); + + // 웹 전송 타입 지정 + var webConType = CommonProperty.WebConnectionType.GET; + + // 1. WebRequest 객체 형성 및 HttpWebRequest 로 형변환 + // 2. 거래소에 따른 헤더 파일 처리(POST 일 경우만 지정함) + + + if(string.IsNullOrEmpty(url)) + { + switch (exchangeWebReqType) + { + #region Upbit + case CommonProperty.ExchangeWebReqType.UpbitMarket: + wReq = (HttpWebRequest)WebRequest.Create(new Uri(CommonProperty.UpbitURL_MarketInfo)); + break; + #endregion + + #region Bitget + case CommonProperty.ExchangeWebReqType.BitgetMarket_Spot: + wReq = (HttpWebRequest)WebRequest.Create(new Uri(CommonProperty.BitgetURL_MarketInfo_COIN)); + break; + + case CommonProperty.ExchangeWebReqType.BitgetMarket_Future: + wReq = (HttpWebRequest)WebRequest.Create(new Uri(CommonProperty.BitgetURL_MarketInfo_FUTURE)); + break; + + case CommonProperty.ExchangeWebReqType.BitgetCandleStick_Coin: + wReq = (HttpWebRequest)WebRequest.Create(new Uri(CommonProperty.BitgetURL_MarketCandle_Coin)); + break; + case CommonProperty.ExchangeWebReqType.BitgetCandleStick_Future: + wReq = (HttpWebRequest)WebRequest.Create(new Uri(CommonProperty.BitgetURL_MarketCandle_Future)); + break; + #endregion + + } + } + else wReq= (HttpWebRequest)WebRequest.Create(new Uri(url)); + + + // GET, POST 구분 + switch (webConType) + { + case CommonProperty.WebConnectionType.GET: + break; + case CommonProperty.WebConnectionType.POST: + wReq.Method = "POST"; // 전송 방법 "GET" or "POST" + using (var stream = wReq.GetRequestStream()) + { + stream.Write(rgbyData, 0, rgbyData.Length); + } + wReq.ContentType = "application/x-www-form-urlencoded"; + wReq.ContentLength = rgbyData.Length; + break; + } + + using (var wRes = (HttpWebResponse)wReq.GetResponse()) + { + var respPostStream = wRes.GetResponseStream(); + var readerPost = new StreamReader(respPostStream, Encoding.UTF8, true); + var resResult = readerPost.ReadToEnd(); + switch (exchangeWebReqType) + { + #region Bitget + case CommonProperty.ExchangeWebReqType.BitgetMarket_Spot: + { + var datalist = JsonConvert.DeserializeObject>(resResult); + var marketInfo = JsonConvert.DeserializeObject>>(datalist["data"]?.ToString()); + var data = marketInfo.FindAll(x => x["coin"].ToString().Contains("USDT")); + } + break; + case CommonProperty.ExchangeWebReqType.BitgetMarket_Future: + { + var datalist = JsonConvert.DeserializeObject>(resResult); + var marketInfos = JsonConvert.DeserializeObject>>(datalist["data"]?.ToString()); + + commonProperty.marketInfoList = new List(); + + foreach (var item in marketInfos) + { + MarketInfo marketInfo = new MarketInfo(); + marketInfo.MarketName = item["symbol"].ToString(); + marketInfo.ExchangePlace = Enum.GetName(typeof(CommonProperty.ExchangePlace), commonProperty.selectedChangePlace); + commonProperty.marketInfoList.Add(marketInfo); + } + + return commonProperty.marketInfoList; + } + break; + case CommonProperty.ExchangeWebReqType.BitgetCandleStick_Coin: + { + + } + break; + case CommonProperty.ExchangeWebReqType.BitgetCandleStick_Future: + { + var datalist = JsonConvert.DeserializeObject>(resResult); + var datas = JsonConvert.DeserializeObject>>(datalist["data"]?.ToString()); + + List candleDatas = new List(); + + foreach(var item in datas) + { + CandleData candleData = new CandleData(); + candleData.Argument = Convertor.GetUnixtimeStampToDateTime(long.Parse(item[0].ToString())); + candleData.Open = Convert.ToDouble(item[1]); + candleData.High = Convert.ToDouble(item[2]); + candleData.Low = Convert.ToDouble(item[3]); + candleData.Close = Convert.ToDouble(item[4]); + candleData.Vol_C = Convert.ToDouble(item[5]); + candleData.Vol_USD = Convert.ToDouble(item[6]); + + candleDatas.Add(candleData); + } + + return candleDatas; + } + break; + #endregion + } + } + } + catch (WebException webEx) + { + using (var Response = (HttpWebResponse)webEx.Response) + { + var nCode = Response.StatusCode; + + using (var reader = new StreamReader(Response.GetResponseStream())) + { + var sRespBodyData = reader.ReadToEnd(); + + //return (JObject.Parse(sRespBodyData)); + } + } + } + + return returnJsonData; + } + } +} diff --git a/BitgetApi/bin/Debug/BitgetApi.exe b/BitgetApi/bin/Debug/BitgetApi.exe new file mode 100644 index 0000000..35bb770 Binary files /dev/null and b/BitgetApi/bin/Debug/BitgetApi.exe differ diff --git a/BitgetApi/bin/Debug/BitgetApi.exe.config b/BitgetApi/bin/Debug/BitgetApi.exe.config new file mode 100644 index 0000000..56efbc7 --- /dev/null +++ b/BitgetApi/bin/Debug/BitgetApi.exe.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/BitgetApi.pdb b/BitgetApi/bin/Debug/BitgetApi.pdb new file mode 100644 index 0000000..58a30b5 Binary files /dev/null and b/BitgetApi/bin/Debug/BitgetApi.pdb differ diff --git a/BitgetApi/bin/Debug/CommonProperty.json b/BitgetApi/bin/Debug/CommonProperty.json new file mode 100644 index 0000000..ccde25c --- /dev/null +++ b/BitgetApi/bin/Debug/CommonProperty.json @@ -0,0 +1,875 @@ +{ + "selectedChangePlace": 2, + "selectedPaymentType": 0, + "selectedBitgetProductType": 1, + "marketInfoList": [ + { + "ExchangePlace": "Bitget", + "MarketName": "BTCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ETHUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XRPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "EOSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BCHUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LTCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ADAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ETCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LINKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TRXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DOTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DOGEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SOLUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MATICUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BNBUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "UNIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ICPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AAVEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FILUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XLMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ATOMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XTZUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SUSHIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AXSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "THETAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AVAXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SHIBUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MANAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GALAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SANDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DYDXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CRVUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NEARUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "EGLDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KSMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ARUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FTMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PEOPLEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LRCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NEOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WAVESUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ALGOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "IOTAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ENJUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GMTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ZILUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "IOSTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "APEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RUNEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KNCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "APTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CHZUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ROSEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ZRXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KAVAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ENSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GALUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SXPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "C98USDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RSRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SNXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "STORJUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "1INCHUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "COMPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "IMXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LUNA2USDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FLOWUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "QTUMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "API3USDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MASKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WOOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GRTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BANDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "STGUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LUNCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ONEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "JASMYUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MKRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BATUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MAGICUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LDOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OCEANUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CELOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BLURUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MINAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "COREUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CFXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ASTRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AGIXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GMXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ANKRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ACHUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FETUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FXSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RNDRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "HOOKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BNXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SSVUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "USDCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LQTYUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "STXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TRUUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "HBARUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "INJUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BELUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "COTIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "VETUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ARBUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LOOKSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KLAYUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FLMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OMGUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CKBUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "IDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LITUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "JOEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TLMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "HOTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CHRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RDNTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ICXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ONTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "UNFIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NKNUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ARPAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DARUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SFPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SKLUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RVNUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CELRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FLOKIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SPELLUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SUIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PEPEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "IOTXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "STMXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BSVUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TONUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GTCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DENTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ORDIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KEYUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "1000BONKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LEVERUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "RADUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "QNTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MAVUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XVGUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "1000XECUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AGLDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WLDUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PENDLEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ARKMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CVXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "YGGUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OGNUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LPTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BNTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SEIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CYBERUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BAKEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LOOMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BIGTIMEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ORBSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WAXPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "POLYXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TIAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MEMEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PYTHUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "JTOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "1000SATSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "1000RATSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ACEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XAIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MANTAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ALTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "JUPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ZETAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "STRKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PIXELUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "DYMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WIFUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AXLUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BEAMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BOMEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "METISUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NFPUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "VANRYUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AEVOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ETHFIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ONDOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CAKEUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "PORTALUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NTRNUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "KASUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "AIUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ENAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "WUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "CVCUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TNSRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SAGAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "TAOUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "FRONTUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ATAUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "SUPERUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "ONGUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "OMNI1USDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "LSKUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "GLMUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "REZUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "XVSUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "MOVRUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "VGXUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "BBUSDT" + }, + { + "ExchangePlace": "Bitget", + "MarketName": "NOTUSDT" + } + ] +} \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.dll new file mode 100644 index 0000000..7ab2f8d Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.xml new file mode 100644 index 0000000..0f4c9e2 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Data.Desktop.v23.2.xml @@ -0,0 +1,1552 @@ + + + + DevExpress.Data.Desktop.v23.2 + + + + + Provides types that describe video capture devices and video properties. + + + + + The base class for classes that describe video capture devices. + + + + + Initializes a new instance of the class with the specified settings. + + An object that comprises system information about the video capture device. + + + + Gets the string representation of the moniker for the current device. + + A String value that specifies the string representation of the moniker for the current device. + + + + Disposes of the current object and releases all the allocated resources. + + + + + Determines whether the specified object is equal to the current object. + + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns the list of video resolutions available on the current device. + + The list of video resolutions available on the current device. + + + + Returns the list of video resolutions available on the current device. + + The list of video resolutions available on the current device. + + + + Returns the hash code for the current object. + + The hash code for the current object. + + + + Gets whether the video capture device is already in use in another application. + + true, the video capture device is already in use in another application; otherwise, false. + + + + Gets whether the device is currently capturing video. + + true, if the device is currently capturing video; otherwise, false. + + + + Gets the UI display name of the video capture device. + + A String value that specifies the UI display name of the video capture device. + + + + Gets or sets the resolution of a video stream captured by the current device. + + A structure that specifies the resolution of a video stream captured by the current device. + + + + Sets the ICameraDeviceClient object that processes the video from the current capture device. + + An ICameraDeviceClient object that processes the video from the current capture device. + + + + Starts capturing video from the current device. + + + + + Stops capturing video from the current device. + + + + + Returns the video frame currently captured by the device. + + A object that is the video frame currently captured by the device. + + + + Processes Windows messages. + + The Windows Message to process. + + + + Contains system information used to identify a video capture device. + + + + + Initializes a new instance of the class with the specified settings. + + A String value that specifies the string representation of the moniker for the video capture device. This value is assigned to the CameraDeviceInfo.MonikerString field. + A String value that specifies the UI display name of the video capture device. This value is assigned to the CameraDeviceInfo.Name field. + + + + Initializes a new instance of the class with the specified settings. + + A String value that specifies the string representation of the moniker for the video capture device. This value is assigned to the CameraDeviceInfo.MonikerString field. + + + + Compares the current instance with a specified object and indicates whether the current instance precedes, follows, or appears at the same position in the sort order as the specified object. + + An object to compare with the current instance. + An integer value that specifies whether the current instance precedes, follows, or appears at the same position in the sort order as the specified object. + + + + The string representation of the moniker for the video capture device. + + + + + The UI display name of the video capture device. + + + + + Returns the UI display name of the video capture device. + + A String value that is the UI display name of the video capture device. + + + + Describes a video property on a video capture device. + + + + + Gets the default value of the video property. + + An value that specifies the default value of the video property. + + + + Gets the maximum value of the video property. + + An value that specifies the maximum value of the video property. + + + + Gets the minimum value of the video property. + + An value that specifies the minimum value of the video property. + + + + Gets the name of the video property. + + A value that specifies the name of the video property. + + + + Occurs when a property value changes. + + + + + Resets the video property value to its default. + + + + + Gets the step size for the video property. The step size is the smallest increment by which the property can change. + + An value that specifies the step size for the video property. + + + + Gets or sets the current setting of the video property. + + An value that specifies the current setting of the video property. + + + + Provides access to the video properties on a video capture device. + + + + + Initializes a new instance of the class with the specified settings. + + An ICameraDeviceClient object that processes the video stream received from a video capture device. + + + + Provides access to the video property that specifies the backlight compensation setting. + + A object that is the video property specifying the backlight compensation setting. + + + + Provides access to the video property that specifies the brightness, also called the black level. + + A object that is the video property specifying the brightness, also called the black level. + + + + Provides access to the video property that specifies the color enable setting. + + A object that is the video property specifying the color enable setting. + + + + Provides access to the video property that specifies the contrast. + + A object that is the video property specifying the contrast. + + + + Provides access to the video property that specifies the gain adjustment. + + A object that is the video property specifying the gain adjustment. + + + + Provides access to the video property that specifies the gamma. + + A object that is the video property specifying the gamma. + + + + Provides access to the video property that specifies the hue. + + A object that is the video property specifying the hue. + + + + Occurs when a property value changes. + + + + + Resets the video properties to their defaults. + + + + + Provides access to the video property that specifies the saturation. + + A object that is the video property specifying the saturation. + + + + Provides access to the video property that specifies the sharpness. + + A object that is the video property specifying the sharpness. + + + + Provides access to the video property that specifies the white balance, as a color temperature in degrees Kelvin. + + A object that is the video property specifying the white balance, as a color temperature in degrees Kelvin. + + + + The Chart Control visualizes data rows that are selected within a source control. + + + + + The Chart Control visualizes a source control’s all data rows. + + + + + The Chart Control visualizes data rows that the source control filters. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the control that provides its data rows to another control. + + The control that provides its data rows to another control. + + + + Gets or sets the type of rows that the source control provides. + + The type of rows that the source control provides. + + + + Occurs every time any of the class’ properties has changed its value. + + + + + Reloads data rows from the source control. + + The value indicating whether the PropertyChanged event should be raised. + + + + Initializes new instance of the class with the specified settings. + + The value indicating the currently provided data row type. + + + + Returns the type of changed rows. + + The type of changed rows. + + + + Represents the method that will handle the IControlRowSource.Changed event. + + An object of any type that triggers the IControlRowSource.Changed event. + Event arguments that provide data for the PrintingSystemBase.PrintProgress event. + + + + Occurs every time the data source is changed. + + + + + Returns data rows of the specified row type. + + The requested row type. + Data rows of the specified row type. + + + + Returns the data row source. + + The data row source. + + + + Contains utility classes and interfaces for DevExpress components. + + + + + Allows you to control clipboard-related operations initiated by users and DevExpress UI controls for WinForms and WPF. + + + + + Enables clipboard-related operations for the specified data formats. + + Data formats. + + + + Enables the specified clipboard-related operation(s) for the specified data format. + + The clipboard-related operation. + The data format. + + + + Enables the specified clipboard-related operation. + + The clipboard-related operation. + + + + Fires after a DevExpress UI control has cleared the clipboard. + + + + + Fires when a DevExpress UI control attempts to clear the clipboard and allows you to allow (or cancel) the operation. + + + + + Contains data for clipboard-related events. + + + + + Gets the data format. + + The data format. + + + + Gets an object that defines a format-independent mechanism for transferring data. + + An object that implements IDataObject. null (Nothing in Visual Basic) if there is no object. + + + + Gets a value that indicates whether the clipboard clear operation is being processed. + + true if the clipboard clear operation is being processed; otherwise, false. + + + + Gets a value that indicates whether the copy-to-clipboard operation is being processed. + + true if the copy-to-clipboard operation is being processed; otherwise, false. + + + + Gets a value that indicates whether the paste-from-clipboard operation is being processed. + + true if the paste-from-clipboard operation is being processed; otherwise, false. + + + + Gets the clipboard-related operation being processed. + + The clipboard-related operation. + + + + Returns a string representation of the current object. + + A string representation of the current object. + + + + Contains data for clipboard-related events. + + + + + Gets the data format. + + The data format. + + + + Gets an object that defines a format-independent mechanism for transferring data. + + An object that implements IDataObject. null (Nothing in Visual Basic) if there is no object. + + + + Gets a value that indicates whether the clipboard clear operation is being processed. + + true if the clipboard clear operation is being processed; otherwise, false. + + + + Gets a value that indicates whether the copy-to-clipboard operation is being processed. + + true if the copy-to-clipboard operation is being processed; otherwise, false. + + + + Gets a value that indicates whether the paste-from-clipboard operation is being processed. + + true if the paste-from-clipboard operation is being processed; otherwise, false. + + + + Gets a value that indicates whether a DevExpress UI control requests a copy/paste operation to update its UI (for example, menu commands). + + true if the DevExpress UI control requests a copy/paste operation to update its UI; otherwise, false. + + + + Gets the clipboard-related operation being processed. + + The clipboard-related operation. + + + + Returns a string representation of the current object. + + A string representation of the current object. + + + + Fires after the user has copied data displayed in a DevExpress control to the clipboard. + + + + + Fires when the user attempts to copy data displayed in a DevExpress control to the clipboard and allows you to allow (or cancel) the operation. + + + + + Allows you to respond to associated failures. + + + + + Contains data for the event. + + + + + Gets the exception. + + The exception. + + + + Gets or sets whether to throw an exception. + + true to throw an exception; otherwise, false. + + + + Returns a string representation of the current object. + + A string representation of the current object. + + + + Fires after the user has pasted data into a DevExpress control from the clipboard. + + + + + Fires when the user attempts to paste data into a DevExpress control from the clipboard and allows you to allow (or cancel) the operation. + + + + + Applies a policy to suppress all clipboard-related operations within DevExpress WinForms and WPF controls (including operations performed by DevExpress WinForms and WPF controls). + + + + + Applies a policy to suppress clipboard clearing operations performed by DevExpress WinForms and WPF controls. + + + + + Applies a policy to suppress clipboard-access operations performed by DevExpress WinForms and WPF controls. + + + + + Applies a policy to suppress all copy-to-clipboard operations within DevExpress WinForms and WPF controls. + + + + + Applies a policy to suppress all paste-from-clipboard operations within DevExpress WinForms and WPF controls. + + + + + Applies a policy that suppresses all clipboard-related operations in DevExpress WinForms and WPF controls. + + + + + Applies a policy that throws an exception when a clipboard-related operation fails in a DevExpress WinForms or WPF control. + + + + + Allows you to control processes initiated by DevExpress UI controls in response to user actions. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The service. + + + + Allows you to respond to associated failures. + + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The exception. This value is assigned to the property. + + + + Gets the exception. + + The exception. + + + + Gets or sets whether to throw an exception. + + true to throw an exception; otherwise, false. + + + + Registers a trusted resource. + + The trusted resource. + The arguments. + + + + Registers a trusted resource. + + The trusted resource. + + + + Applies a policy that displays a confirmation dialog that prompts a user to confirm or cancel a process. + + + + + Fires after a process has started. + + + + + Fires before a process starts and allows you to cancel the process. + + + + + Applies a policy that suppresses all new processes. + + + + + Applies a policy that throws an exception when a process is about to start. + + + + + Throws an exception if a process fails to start. + + + + + Contains classes that provide the basic printing functionality. + + + + + Provides settings for a printer. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets a comment about a printer. + + A string that specifies the comment about the printer. + + + + Gets the printer display name. + + A string that specifies the printer display name. + + + + Gets the printer full name. + + A string that specifies the printer name. + + + + Gets the printer location. + + A string that specifies the printer location. + + + + Gets information on documents in the print queue. + + A string that specifies the documents in the print queue. + + + + Gets the printer type. + + The printer type. + + + + Gets the printer status. + + A string that specifies the printer status. + + + + An element of an HTML-CSS template. + + + + + Initializes a new instance of the class with specified settings. + + + + + Returns the number of elements owned by this HTML element (the length of the DxHtmlElement.Children collection). + + The number of HTML elements owned by this element. + + + + Returns HTML elements owned by this element. This collection includes only direct children; elements owned by child elements are not included. + + The collection of child HTML elements. + + + + Gets or sets the name of the CSS style applied to this element. + + The name of the CSS style applied to this element. + + + + Returns the height of the element’s client area (the area that contains child elements of this HTML element). + + The height of this element’s client area. + + + + Returns the distance between the element’s left border and the left border of this element’s client area (the area that contains child elements of this HTML element). + + The left margin of the element’s client area. + + + + Returns the distance between the element’s top border and the top border of this element’s client area (the area that contains child elements of this HTML element). + + The top margin of the element’s client area. + + + + Returns the width of the element’s client area (the area that contains child elements of this HTML element). + + The width of this element’s client area. + + + + Gets or sets whether this element is disabled. Disabled elements do not trigger HtmlElementMouseClick and HtmlElementMouseDown events, and are styled with the “main_class_name:disabled” CSS pseudo-class. + + true if this element is disabled; otherwise, false. + + + + Returns an item of this element’s Children collection that has the target ID. If multiple items are present, it returns the first found item. + + The ID to search. + The HTML element with the target ID. + + + + Returns all of this element’s Children collection items that are styled with the target CSS class. + + The name of a CSS style to find. + The list of found HTML elements. + + + + Returns all of this element’s Children collection items that have the specific tag. + + The tag to find. + The collection of child elements with the given tag. + + + + Gets or sets whether this element is focused. Focused elements are styled with the “main_class_name:focus” CSS pseudo-class. + + true to focus the element and apply the “:focus” CSS pseudo-class; false to unfocus the element and apply the regular CSS style. + true if the item was successfully focused; otherwise, false. + + + + Modifies all child elements that match the given predicate. This method searches for matching elements recursively: first among this element’s Children collection, then among child elements of these children, and so on, until it reaches the lowermost elements. + + The action that modifies found elements. + The condition used to find HTML elements. + + + + Returns the actual CSS style applied to this element. + + The actual CSS style of this element. + + + + Gets or sets whether this element is shown on-screen. + + true to completely hide this element; false to display the element. + + + + Gets or sets the unique element identifier. You can search elements by their IDs with the FindElementById(String) method. + + The element identifier. + + + + Gets or sets whether this element is selected. Focused elements are styled with the “main_class_name:select” CSS pseudo-class. + + true to select the element and apply the “:select” CSS pseudo-class; false to deselect the element and apply the regular CSS style. + true if the element was successfully selected; otherwise, false. + + + + Gets or sets the element tooltip. + + The tooltip displayed when a user hovers over this element. + + + + Stores information about an HTML element with which a user has interacted. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Returns whether this element can pass an event up along the tree, to its parent HTML elements. You can enable the CancelBubble property to stop an event at this control level. See any “HtmlElementMouse~” event description for more details on bubbling (for example, WinExplorerView.HtmlElementMouseClick). + + true if this element can pass an event to its parent elements; otherwise, false. + + + + Specifies whether this element should pass an event to its parent elements. See any “HtmlElementMouse~” event description for more information about bubbling (for example, WinExplorerView.HtmlElementMouseClick). + + true to prevent an event from bubbling up along the element tree; otherwise, false. + + + + Returns the unique identifier of an HTML element. Element IDs are set in HTML markup (the “id” property). See any “HtmlElementMouse~” event description for more information (for example, WinExplorerView.HtmlElementMouseClick). + + The unique identifier of an HTML element. + + + + Specifies whether a control whose HTML element triggered this event should raise its own related event. See any “HtmlElementMouse~” event description for more information (for example, WinExplorerView.HtmlElementMouseClick). + + true if a parent control’s own event should not fire; otherwise, false. + + + + Stores information about a mouse action that triggered a related event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + Stores information about a clicked element. + Stores information about a mouse pointer. + + + + Initializes a new instance of the class with specified settings. + + Stores information about a mouse pointer. + + + + Returns actual bounds of a clicked element. The returned value depends on the screen scaling. For example, the Bounds property for a square div element with 50px sides returns Height and Width values of 100px when shown on a display with a 200% Windows scaling option. + + A Rectangle that stores location and size of a related element. + + + + Returns the clicked mouse button. + + The clicked mouse button. + + + + Returns the number of clicks. + + The number of returned clicks. + + + + Returns information about a clicked element. + + Stores information about a clicked element. + + + + Returns information about a mouse pointer. + + Stores information about a mouse pointer. + + + + Returns the X coordinate of a mouse pointer. + + The X coordinate of a mouse pointer. + + + + Returns the Y coordinate of a mouse pointer. + + The Y coordinate of a mouse pointer. + + + + Contains common utility classes used by WPF controls and components from DevExpress. + + + + + An abstract class that provides access to an application’s theme settings. + + + + + Gets or sets the name of the theme applied to the entire application. + + A value that specifies the theme name. + + + + Gets or sets where to save the application theme name. + + A path to the application configuration file. + + + + Preloads theme resources for the specified controls. + + A collection of DevExpress WPF controls. + + + + Preloads theme resources for the view specified by the and allows you to initialize this view before the preload. + + A function that initializes the preloaded . + + + + Preloads theme resources for the view specified by the . + + true to invoke static constructors; otherwise, false. + A or its descendant. + + + + Asynchronously preloads theme resources for the specified controls. + + A collection of DevExpress WPF controls. + A task that allows you to asynchronously preload theme resources. + + + + Asynchronously preloads theme resources for the view specified by the and allows you to initialize this view before the preload. + + A function that initializes the preloaded . + A task that allows you to asynchronously preload theme resources. + + + + Asynchronously preloads theme resources for the view specified by the . + + A or its descendant. + A task that allows you to asynchronously preload theme resources. + + + + Saves the current theme name to the application configuration file. + + + + + Loads the theme name from the application configuration file. + + + + + Gets or sets whether to display vector or bitmap icons within WPF controls. + + true to display vector icons; false to display bitmap icons. + + + + Specifies whether the application should use the legacy default theme (“DeepBlue”). + + + + + Lists the values that specify the compatibility settings version. + + + + + The DevExpress WPF controls function like in the latest version. + + + + + The DevExpress WPF controls function like in v17.2. + + + + + The DevExpress WPF controls function like in v18.1. + + + + + The DevExpress WPF controls function like in v18.2. + + + + + The DevExpress WPF controls function like in v19.1. + + + + + The DevExpress WPF controls function like in v19.2. + + + + + The DevExpress WPF controls function like in v20.1. + + + + + The DevExpress WPF controls function like in v20.2. + + + + + The DevExpress WPF controls function like in v21.1. + + + + + The DevExpress WPF controls function like in v21.2. + + + + + The DevExpress WPF controls function like in v22.1. + + + + + Provides access to compatibility settings. + + + + + Gets or sets whether to enable UI Automation-based accessibility alerts for validation errors. + + true to enable UI Automation-based accessibility alerts for validation errors; otherwise, false. + + + + Gets or sets whether users can edit a format condition’s expression text. + + true to allow users to edit a format condition’s expression text; otherwise, false. + + + + Gets or sets whether the GridControl’s logic of getting/setting the editor’s value is enabled. + + true, if the GridControl’s logic of getting/setting the editor’s value is enabled; otherwise, false.The default value is true. + + + + Gets or sets whether to use the GlyphRun engine to render text in cell editors. + + true to use the GlyphRun engine; otherwise, false. + + + + Gets or sets whether to allow users to filter grid values in the Drop-down Filter and Filter Editor when the is in the . + + true to allow users to filter grid values in the Drop-down Filter and Filter Editor when the is in the ; otherwise, false. + + + + Gets or sets whether ribbon controls should attempt to re-use existing link control (LightweightBarItemLinkControl, BarButtonItemLinkControl, BarCheckItemLinkControl, and so on) objects to enhance merging performance. + + true, to re-use an existing link control; otherwise false. + + + + Gets or sets whether to enable the legacy Theme Preload. + + true to enable the legacy Theme Preload; otherwise, false. + + + + Gets or sets whether to display the Column Chooser in the legacy window. + + true to display the Column Chooser in the legacy window; false to use this legacy window only if the is in a pop-up window. + + + + Gets or sets whether to display the Runtime Summary Editor in the legacy window. + + true to display the Runtime Summary Editor in the legacy window; false to use this legacy window only if the is in a pop-up window. + + + + Gets or sets the controls’ compatibility mode. + + A compatibility mode. + + + + Specifies whether a recurring appointment is converted to a normal appointment when an end-user drags and drops it to another resource. + + True, if a recurring appointment is converted to normal after a drag-and-drop operation to another resource; otherwise, false. Default is false. + + + + Gets or sets a value that specifies how the DXBinding (DXEvent, DXCommand) markup extensions resolve input expressions. + + Any of the enumeration values. + + + + Gets or sets whether to enable DPI correction to improve layout rendering. + + true, to enable DPI correction; otherwise false. + + + + Gets or sets whether to hide the Calendar Button from the Date Navigation Panel. + + true to hide the Calendar Button from the Date Navigation Panel; otherwise, false. + + + + Gets or sets whether TimeSpan masks should hide optional segments. + + false to hide optional segments in TimeSpan masks; otherwise true. + + + + Specifies a legacy default theme which the application should use. + + A legacy default theme. + + + + Gets or sets whether the Window.GetWindow() method should return the floating window’s position in relation to the main window’s position (where the DockLayoutManager manager is placed). + + true to return a floating window’s related prosition; otherwise false. + + + + Gets or sets whether editors should automatically update their selection to highlight a selected mask part that a user can edit. + + true, to update editor selection to highlight a selected mask part that a user can edit; otherwise, false. + + + + Specifies whether to update the in a single batch during the data source synchronization. + + true, to restore the legacy (slower) behavior; otherwise, false. + + + + Specifies whether the DiagramControl’s data binding engine prioritizes the IListSource interface over the IEnumerable. + + true, to prioritize the IListSource interface; false, to prioritize the IEnumerable interface. + + + + Gets or sets whether to render page content with DirectX. + + true, to enable DirectX page content rendering; false, to render page content with GDI/GDI+. The default is true. + + + + Gets or sets the SchedulerControl UI style. + + By default, Outlook2019. + + + + Specifies whether to display the Date Navigation Panel by default. + + true, to display the WPF Scheduler’s Date Navigation Panel by default, otherwise, false. + + + + Gets or sets whether TrackBarEdit should increment or decrement its value when a user clicked a line next to the thumb. + + true to increment or decrement TrackBarEdit value when a user clicks a line next to the thumb; otherwise false. + + + + Specifies whether to use the control to render the ‘s dropdown window. + + true to use the DateNavigator in the DateEdit‘s dropdown; otherwise, false. + + + + Gets or sets whether the Between Dates and On Dates date operators are used. + + true, to use the Between Dates and On Dates date operators; otherwise, false. + + + + Gets or sets whether the legacy calendar is used in the . + + true, to use the legacy calendar; otherwise, false. + + + + Gets or sets whether the legacy drop-down filter is used. + + true, to use the legacy drop-down filter; otherwise, false. + + + + Gets or sets whether to use the legacy Null Value button in the ButtonEdit editor and its descendants. + + true, to use the legacy Null Value button; otherwise, false. + + + + Gets or sets whether DevExpress WPF Controls display their messages in the legacy message box. + + true if DevExpress WPF Controls display their messages in the legacy message box; otherwise, false. + + + + Gets or sets whether the legacy filter editor is used. + + true, to use the legacy filter editor; otherwise, false. + + + + Gets or sets whether to use the legacy filter panel. + + true, to use the legacy filter panel; otherwise, false. + + + + Specifies whether to calculate and individually for each ‘s occurrence. + + true, to calculate QueryStart and QueryEnd individually for each occurrence; false, to use the pattern’s QueryStart and QueryEnd for changed and deleted occurrences. + + + + Specifies whether to use decoration panels to draw the ‘s elements. + + true to use the legacy mechanism affected by the CellControl’s customization properties; false to use decoration panels. + + + + Specifies whether to revert to the legacy Timeline view. + + true, to revert to the legacy Timeline view; otherwise, false. + + + + Gets or sets whether to display the Ribbon Customization Options in the legacy window. + + true to display the Ribbon Customization Options in the legacy window; otherwise, false. + + + + Gets or sets whether optimized mode should be enabled for all items. This property should be set at the application’s startup before loading bar components. + + true to enable optimized mode for all items; otherwise false. + + + + Gets or sets whether the dx:ButtonThemeKey resource containing the Button template should use the ResourceKey=ButtonControlTemplate. + + true, to use ResourceKey=ButtonControlTemplate in the dx:ButtonThemeKey resource; otherwise false. + + + + Gets or sets whether to use lightweight themes within the application. + + true to use lightweight themes within the application; otherwise, false. + + + + Gets or sets whether to enable the middle-click to scroll functionality. + + true to enable the middle-click to scroll functionality; otherwise, false. + + + + Gets or sets whether to enable a ribbon’s deferred page merging. + + true to merge ribbon’s page content only when a user opens the page; otherwise, false. + + + + Gets or sets whether to use the ThemedMessageBox instead of DXMessageBox in WindowService, DialogService, and WindowedDocumentUIService. + + true, to use the ThemedMessageBox; otherwise, false. + + + + Specifies whether to revert to the Wait Indicator control that uses the theme resources. + + true, to revert to the Wait Indicator control that uses the theme resources; otherwise, false. The default value is false. + + + + Gets or sets whether to use the instead of in WindowService, DialogService, and WindowedDocumentUIService. + + true, to use the ; otherwise, false. + + + + Specifies whether editors set the 0 (zero) or null value after the last digit is removed. + + A mode that specifies whether editors set the 0 (zero) or null value after the last digit is removed. + + + + Lists values that specify how the DXBinding (DXEvent, DXCommand) markup extensions resolve input expressions. + + + + + The DXBinding, DXCommand and DXEvent markup extensions interpret their expressions that allows them using dynamic typization, so you do no need to cast values. + + + + + The DXBinding, DXCommand and DXEvent markup extensions compile their expressions thus using static typization, so you do need to cast values. + + + + + Lists legacy default themes. + + + + + The DeepBlue legacy default theme. The theme was default in the v16.1 WPF Controls and prior. + + + + + The Office2016White legacy default theme. The theme was default in the v20.1 WPF Controls and prior. + + + + + Lists values that correspond to DevExpress WPF controls. + + + + + The Accordion Control + + + + + Chart Controls + + + + + All controls from the DevExpress.Xpf.Controls assembly + + + + + All controls from the DevExpress.Xpf.Core assembly (Data Editors, Bars, etc.) + + + + + The WPF Dashboard Viewer + + + + + The Diagram Control + + + + + File Dialogs + + + + + The Dock and Layout Manager + + + + + The Expression Editor + + + + + The Gantt Control + + + + + Gauge Controls + + + + + The Data Grid Control + + + + + Layout Controls + + + + + The Map Control + + + + + The PDF Viewer for WPF + + + + + The Pivot Grid Control + + + + + The + + + + + The Property Grid Control + + + + + The End-User Report Designer for WPF + + + + + The Ribbon Control + + + + + The WPF Rich Text Editor + + + + + The Scheduler Control + + + + + The WPF Spreadsheet Control + + + + + The TreeMap Control + + + + + Lists the values that specify the NumericMaskOptions.ValueAfterDelete property. + + + + + When a user removes the last digit, the editor value becomes null. + + + + + When a user removes the last digit, the editor value becomes 0 (zero). If a user presses the Backspace or Delete key to remove this zero, the editor value becomes null. + + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Data.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.Data.v23.2.dll new file mode 100644 index 0000000..5b4592e Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Data.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Data.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.Data.v23.2.xml new file mode 100644 index 0000000..44b52a8 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Data.v23.2.xml @@ -0,0 +1,20497 @@ + + + + DevExpress.Data.v23.2 + + + + + Contains classes that implement the DevExpress Dashboard cross-platform functionality. + + + + + Lists values used to specify how a Chart dashboard item should be resized when being exported. + + + + + The Chart dashboard item is exported in a size identical to that shown on the dashboard. + + + + + The Chart dashboard item is stretched or shrunk to fit the page to which it is exported. + + + + + The Chart dashboard item is resized proportionally to best fit the exported page. + + + + + Lists values that specify a scale mode when exporting a dashboard/dashboard item. + + + + + The size of the dashboard / dashboard item is changed according to the width of the exported pages. + + + + + The dashboard / dashboard item on the exported page retains its original size. + + + + + The size of the dashboard / dashboard item on the exported page is changed according to the scale factor value. + + + + + Lists values that specify the format used to export a dashboard/dashboard item to an image. + + + + + The GIF image format. + + + + + The JPG image format. + + + + + The PNG image format. + + + + + Lists values that specify the page orientation used to export a dashboard/dashboard item. + + + + + The page orientation used to export a dashboard/dashboard item is landscape. + + + + + The page orientation used to export a dashboard/dashboard item is portrait. + + + + + Lists values that specify the position of the dashboard state (such as master filter or current parameter values) in the exported Excel document. + + + + + The dashboard state is placed below the exported data. + + + + + The dashboard state is placed on a separate sheet. + + + + + Lists values that specify the position of the dashboard state (such as master filter or current parameter values) in the exported document. + + + + + The dashboard state is placed below the exported dashboard/dashboard item. + + + + + The dashboard state is placed on a separate page. + + + + + Allows you to inspect performance (timing) of the main DevExpress BI Dashboard’s data processing operations. + + + + + Initializes a new instance of the class with specified settings. + + The benchmark name. + + + + Releases all resources used by . + + + + + Collects actions for each event of an event session. + + The benchmark name. + The delegate that encapsulates a method to execute. The method should take no arguments and have no return value. + + + + Collects actions for each event of an event session. + + The benchmark name. + The delegate that encapsulates a method to execute. The method should return a value of the specified type. + The type of the return value. + The value of the specified type. + + + + Records all error events since the trace started. + + An object that is used to generate the trace event. + + + + Records the object’s information that is collected since the trace started. + + An object that is used to generate the trace event. + + + + Records all notification events since the trace started. + + An object that is used to generate the trace event. + + + + Lists values that specify the Excel format used for exporting. + + + + + A comma-separated values (CSV) file format. + + + + + The Excel 97 - Excel 2003 (XLS) file format. + + + + + The Office Excel 2007 XML-based (XLSX) file format. + + + + + Lists values used to specify how a Map dashboard item should be resized when being exported. + + + + + A map dashboard item is exported in a size identical to that shown on the dashboard. + + + + + A map dashboard item is resized proportionally to best fit the exported page. + + + + + Lists values used to specify how a Range Filter dashboard item should be resized when being exported. + + + + + A Range Filter dashboard item is exported in a size identical to that shown on the dashboard. + + + + + A Range Filter dashboard item is stretched or shrunk to fit the page to which it is exported. + + + + + A Range Filter dashboard item is resized proportionally to best fit the exported page. + + + + + Lists values used to specify how a Treemap dashboard item should be resized when being exported. + + + + + A Treemap dashboard item is exported in a size identical to that shown on the dashboard. + + + + + A Treemap dashboard item is resized proportionally to best fit the exported page. + + + + + Contains classes that implement the Web Dashboard control. + + + + + Contains options that allow you to configure data request parameters. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to load data for items that are not currently displayed. + + A enumeration value that specifies whether to load data for items that are currently invisible. + + + + Gets or sets whether a dashboard control loads dashboard items’ data using batch requests or separate requests. + + A enumeration value that specifies a data request mode. + + + + Lists values used to specify whether to load data for all dashboard items or only for those that are visible. + + + + + Load all dashboard items. + + + + + Load dashboard items on demand. + + + + + Lists values used to specify an item’s data request mode. + + + + + For Web Forms, the auto mode is BatchRequests. For other platform, the auto mode is SeparateRequests. + + + + + Detailed items grouped by the same master filter item perform one batch request. + + + + + Detailed items grouped by the same master filter item perform simultaneous separate requests. + + + + + Lists values that specify data limitation modes. + + + + + Visible data will be limited only in the designer mode. + + + + + Visible data will be limited both in the designer and viewer modes. + + + + + Visible data will not be reduced. + + + + + Lists values that specify a mobile layout mode for the Web Dashboard. + + + + + A mobile layout is used both for mobile phones and desktop applications. + + + + + A mobile layout is enabled automatically when the Web Dashboard is used on the mobile phones. + + + + + A desktop layout is used both for mobile phones and desktop applications. + + + + + Lists values used to specify a working mode of the Web Dashboard. + + + + + The Web Dashboard acts as a Dashboard Designer and allows end users to create, edit, and save dashboards. You can switch to Viewer mode on the client side from this mode. + + + + + The Web Dashboard acts as a Dashboard Viewer and allows you to display dashboards to end users. You can switch to Designer mode on the client side from this mode. + + + + + The Web Dashboard acts as a Dashboard Viewer without the capability to switch to Designer mode on the client side. + In this mode, the Web Dashboard does not load the extensions required for designing dashboards. + + + + + Contains classes implementing the common data management functionality for DevExpress controls. + + + + + Contains classes that assist in obtaining information about a data source. + + + + + Provides information about a data source. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A Boolean value. + + + + Returns the display name of a custom data source. + + A value, specifying the data source. + A value, specifying the custom data source display name. + + + + Returns the display name of a data member. + + A value, specifying the data source. + A value, specifying the data member prefix. + A value, specifying the data member. + A value, specifying the data member display name. + + + + Returns the display name of a data member. + + A value, specifying the data source. + A value, specifying the data member. + A value, specifying the data member display name. + + + + Returns the display name of a data source. + + A value, specifying the data source. + A value, specifying the data member. + A value, specifying the data source display name. + + + + Returns the array of data source item properties. + + A value, specifying the data source. + A value, specifying the data member. + A Boolean value. + An array of objects. + + + + Indicates whether the data source is of a custom type. + + A value. + true if the data source is custom; otherwise false. + + + + Indicates whether the data source is of the standard type. + + A value. + true if the data source is standard; otherwise false. + + + + Attempts to obtain the display name of the specified data member. + + A value, specifying the data source. + A value, specifying the data member. + A value, specifying the result. + true if the data member’s display name has been obtained; otherwise false. + + + + Contains types implementing common design-time data browsing functionality for DevExpress controls. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + Lists the available column types. + + + + + The array column type. + + + + + The Boolean column type. + + + + + The Boolean calculated field column type. + + + + + The date-time calculated field column type. + + + + + The default calculated field column type. + + + + + The floating point number calculated field column type. + + + + + The GUID calculated field column type. + + + + + The integer number calculated field column type. + + + + + The string calculated field column type. + + + + + The date-time column type. + + + + + The default column type. + + + + + The floating point number column type. + + + + + The GUID column type. + + + + + The integer number column type. + + + + + The list column type. + + + + + The parameter list column type. + + + + + The source list column type. + + + + + No column type. + + + + + The string column type. + + + + + For internal use. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. + + + + + For internal use. + + + + + Lists values specifying the sort orders. + + + + + Sorts the column in ascending order. + + + + + Sorts the columns in descending order. + + + + + No sorting is applied to a column. + + + + + Contains classes and interfaces enabling you to customize the Expression Editor in WinForms applications. + + + + + Enables customization of Expression Editor items for which automatic completion is available. + + + + + Initializes a new instance of the class with the specified settings. + + A value. This value is assigned to the AutoCompleteItem.Value property. + A value. This value is assigned to the AutoCompleteItem.Description property. + An enumeration value. This value is assigned to the AutoCompleteItem.ItemKind property. + + + + Specifies the description of a suggested automatic completion item displayed in a corresponding tool tip. + + A value. + + + + Indicates the kind of an item for which automatic code completion is available. + + An enumeration value. + + + + Specifies the value of a suggested automatic completion item added to an expression on selecting this item. + + A value. + + + + Lists the items for which automatic completion is available in the Expression Editor. + + + + + The item is a data column. + + + + + The item is a function. + + + + + The item is an operator. + + + + + The item is a parameter. + + + + + Provides information about a data column listed in the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Returns the list of objects associated with columns owned by this column. + + A List<> object that stores objects associated with this column’s children. + + + + Gets or sets the ColumnInfo object related to a column that owns this column. + + A object associated with this column’s parent. + + + + Specifies the type declaration of a data column. + + A object. + + + + Provides information about a static constant listed in the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Enables customization of the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies an object providing a list of items suggested for automatic completion in the Expression Editor. + + An object implementing the interface. + + + + Specifies an object providing a color scheme for painting expression elements in the Expression Editor. + + An object implementing the interface. + + + + Specifies an object that provides information about columns which becomes available only at runtime (as is the case with recurrent data fields in a report’s XtraReportBase.DataSource). + + An object implementing the interface. + + + + Provides access to the collection of data columns available in the Expression Editor. + + A collection of objects. + + + + Provides access to the collection of static constants available in the Expression Editor. + + A collection of objects. + + + + Specifies the object that enables you to access the criteria validator assigned to an Expression Editor. + + An object implementing the interface. + + + + Provides access to the default instance. + + A object. + + + + Provides access to the collection of functions available in the Expression Editor. + + A collection of objects. + + + + Provides access to the collection of operators available in the Expression Editor. + + A collection of objects. + + + + Gets an object providing additional customization settings for the Expression Editor. + + An object. + + + + Provides access to the collection of parameters available in the Expression Editor. + + A collection of objects. + + + + Specifies whether or not the Expression Editor should use the rich text control for operators, functions, and constant descriptions. + + true, to display descriptions using rich text; otherwise, false. + + + + The Expression Editor model. + + + + + Initializes a new instance of the class with the specified expression. + + A value, specifying the expression. + + + + Specifies the expression string. + + A value, specifying the expression. + + + + Enables additional customization of the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether to select the function (and display its description) that is currently being focused in the Expression Editor. + + true, to select the focused function and display its description; otherwise, false. + + + + Specifies whether or not to spell function names in uppercase. + + true, to spell function names in uppercase; false, to spell function names in camel case. + + + + Provides the Presenter functionality to an Expression Editor. + + + + + Initializes a new instance of the class with the specified settings. + + An object. + An object implementing the interface. + An object. + A function delegate, providing additional expression validation on closing the editor with the specified expression (the first string) and error text (the second string). Validation is passed when this parameter is null or empty. Otherwise, the editor cannot be closed (this behavior is defined by the view’s default implementation). + + + + Initializes a new instance of the class with the specified settings. + + An object. + An object implementing the interface. + A function delegate, providing additional expression validation on closing the editor with the specified expression (the first string) and error text (the second string). Validation is passed when this parameter is null or empty. Otherwise, the editor cannot be closed (this behavior is defined by the view’s default implementation). + An object. + + + + Gets an object enabling customization of the Expression Editor. + + An object. + + + + Enables you to launch the Expression Editor in your application at runtime with the specified settings. + + + + + Runs the Expression Editor with the specified settings. + + A value, specifying the expression. + An object implementing the interface. + An object. + A function delegate, providing additional expression validation on closing the editor with the specified expression (the first string) and error text (the second string). Validation is passed when this parameter is null or empty. Otherwise, the editor cannot be closed (this behavior is defined by the view’s default implementation). + true, if the editor was closed by clicking the OK button; otherwise, false. + + + + Runs the Expression Editor with the specified settings. + + A value, specifying the expression. + An object implementing the interface. + An object. + true, if the editor was closed by clicking the OK button; otherwise, false. + + + + Lists the elements of an expression available in the Expression Editor. + + + + + The expression element is a data column. + + + + + The expression element is a static constant. + + + + + The expression element is an error. + + + + + The expression element is a function. + + + + + The expression element is a group of items. + + + + + The expression element is an operator. + + + + + Provides information about a function listed in the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the interface. This value is assigned to the FunctionInfo.CustomFunctionOperator property. + A value, specifying the item category name. This value is assigned to the FunctionInfo.FunctionCategory property. + + + + Initializes a new instance of the class with the specified function operator. + + An object implementing the interface. This value is assigned to the FunctionInfo.CustomFunctionOperator property. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Specifies the type declarations of function arguments. + + An array of objects. + + + + Specifies the caret position after adding a function to an expression. + + An integer value, specifying the number of symbols to the right of the caret position until the end of the function body. + + + + Specifies an object providing instructions required for evaluation of a function. + + An object implementing the interface. + + + + Specifies the full name of a function in the Expression Editor (including the function syntax). + + A value. + + + + Specifies the category to which a function belongs (e.g., “Math”, “String” or “DateTime”). + + A value. + + + + Specifies the example illustrating the function syntax in the Expression Editor panel and tooltip. + + A value. + + + + If implemented, enables you to obtain the list of suggestions corresponding to a specific part of an expression. + + + + + Returns the collection of suggestions corresponding to a specific caret position within an expression. + + A value, specifying the expression. + An integer value, specifying the symbol in the expression where the caret position is. + A collection of objects. + + + + Provides information about data columns which becomes available only at runtime (as is the case with recurrent data fields in a report’s XtraReportBase.DataSource) + + + + + If implemented, enables you to access the criteria validator assigned to an Expression Editor. + + + + + Provides access to an object enabling you to manage the collection of errors found during criteria validation in the Expression Editor. + + An object. + An object. + + + + If implemented, provides a color scheme for painting expression elements in the Expression Editor. + + + + + Returns a color used for painting a specific expression element kind. + + An enumeration value. + A structure. + + + + If implemented, provides the Presenter functionality to an Expression Editor. + + + + + Gets an object enabling customization of the Expression Editor. + + An object. + + + + If implemented, provides the View functionality to an Expression Editor. + + + + + Specifies the expression (in plain text). + + A value. + + + + The base for classes that provide functionality to Expression Editor items (such as constants, functions and data columns). + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Specifies the name of a category to which the Expression Editor item belongs. + + A value. + + + + Specifies the description displayed for an item in the Expression Editor. + + A value. + + + + Specifies the name of an Expression Editor item. + + A value. + + + + Returns the textual representation of . + + A value. + + + + Provides information about an operator listed in the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Provides information about a parameter listed in the Expression Editor. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified prototype. + + A object, specifying a prototype for a new instance. + + + + Initializes a new instance of the class with the specified parameter. + + An object implementing the interface. + + + + Initializes a new instance of the class with the specified category. + + A value, specifying the category name. This value is assigned to the ItemInfoBase.Category property. + + + + Specifies the parameter’s type declaration. + + A object. + + + + Provides data for the GridView.CustomSummaryCalculate event. + + + + + Initializes a new instance of the class. + + + + + Creates a new object. + + An integer value identifying the processed row by its handle. This value is assigned to the CustomSummaryEventArgs.RowHandle property. + An object representing the custom calculated summary value. This value is assigned to the CustomSummaryEventArgs.TotalValue property. + An object representing the currently processed field value. This value is assigned to the CustomSummaryEventArgs.FieldValue property. + An integer value identifying the group row whose child data rows are involved in summary calculation. This value is assigned to the CustomSummaryEventArgs.GroupRowHandle property. + A enumeration value identifying the current calculation stage. This value is assigned to the CustomSummaryEventArgs.SummaryProcess property. + An object representing the summary item whose value is being calculated. This value is assigned to the CustomSummaryEventArgs.Item property. + An integer value indicating the nested group level of the processed row. This value is assigned to the CustomSummaryEventArgs.GroupLevel property. + + + + Gets the processed field value. + + An object representing the processed field value. + + + + Returns the value of the specified group summary for the specified group row. + + An integer that specifies a group row’s handle. + An object representing the group summary item. In the GridControl, it’s represented by the class. + The specified group summary’s value. + + + + Returns the value in the specified field + + A string that identifies the field whose value must be returned. + An object that represents the value of the specified field. + + + + Gets the nested level of the group whose summary value is being calculated. + + An integer value representing the zero-based nested level of the processed group. + + + + Gets a value identifying the group row whose child data rows are involved in summary calculation. + + An integer value representing the handle of the group row containing the processed row as a child. 0 when calculating a total summary value. + + + + Gets whether a group summary value is being calculated. + + true if a group summary value is being calculated; otherwise, false. + + + + Gets whether a total summary value is being calculated. + + true if a total summary value is being calculated; otherwise, false. + + + + Gets a summary item whose value is being calculated. + + An object representing a summary item whose value is being calculated. + + + + Specifies how summaries are calculated - against all rows or for the selected rows. + + An enumeration member that defines the scope of summary calculations. + + + + Gets the currently processed row. + + The currently processed row. + + + + Gets the handle of the processed row. + + An integer value identifying the processed data row by its handle. + + + + Gets a value indicating calculation stage. + + A enumeration value indicating calculation stage. + + + + Gets or sets the total summary value. + + An object representing the total summary value. + + + + Gets or sets whether the Calculation stage of the custom summary calculation process should be skipped. + + true if the Calculation stage of the custom summary calculation process should be skipped; otherwise, false. + + + + Represents a method that will handle the GridView.CustomSummaryCalculate event. + + The event source. + A object containing data related to the event. + + + + Provides data for the GridView.CustomSummaryExists event. + + + + + Initializes a new instance of the class. + + An integer value specifying the handle of the group row whose summary value is about to be calculated. This value is assigned to the CustomSummaryExistEventArgs.GroupRowHandle property. + An integer value specifying the zero-based nesting level of the processed group. This value is assigned to the CustomSummaryExistEventArgs.GroupLevel property. + An object which represents the summary item whose value is about to be calculated. This value is assigned to the CustomSummaryExistEventArgs.Item property. + + + + Gets or sets whether the summary value should be calculated and displayed. + + true to calculate and display the summary value; otherwise, false. + + + + Gets the nesting level of the group whose summary value is being calculated. + + An integer value representing the zero-based nesting level of the processed group. + + + + Gets a value identifying the group row whose summary value is about to be calculated. + + An integer value representing the handle of the group row whose summary value is about to be calculated. 0 when calculating a total summary value. + + + + Gets whether a group summary value is about to be calculated. + + true if a group summary value is about to be calculated; otherwise, false. + + + + Gets whether a total summary value is about to be calculated. + + true if a total summary value is about to be calculated; otherwise, false. + + + + Gets a summary item whose value is about to be calculated. + + An object representing a summary item whose value is about to be calculated. + + + + Represents a method that will handle the GridView.CustomSummaryExists event. + + The event source. + A object containing data related to the event. + + + + Specifies the current status of custom summary calculation. + + + + + Indicates that custom summary calculation is in progress. This means the event is raised for a specific data row containing the field value used to calculate the processed custom summary. + + + + + Indicates that the process of custom summary calculation is finished. + + + + + Indicates that the process of custom summary calculation is about to be started. + + + + + Contains classes that provide functionality required for connecting to Entity Framework data sources. + + + + + Lists the values indicating from where the Report Wizard obtains its data connection settings. + + + + + The Report Wizard lists all available data connections (both the data connections stored in an application’s settings, and in the Visual Studio Server Explorer). + + + + + The Report Wizard does not suggest using any of the available data connections. + + + + + The Report Wizard lists the data connections available in the Visual Studio Server Explorer. + + + + + The Report Wizard lists the data connections available in the application’s configuration file. + + + + + Provides the path to the file that stores connection strings. + + + + + Returns the full path to the file that stores connection strings. + + The full path to the file that stores connection strings + + + + If implemented, provides information about a connection string. + + + + + Indicates from where the Report Wizard obtains its data connection settings. + + A enumeration value. + + + + If implemented, specifies the name of a connection string. + + A value specifying the connection string name. + + + + If implemented, gets the name of the data provider. + + A value specifying the data provider name. + + + + If implemented, obtains the connection string used to establish the data connection at run time. + + A containing a connection string. + + + + Allows you to resolve a connection string by name for the Entity Framework, XPO, and JSON data sources. + + + + + Returns information about connection strings defined in the application configuration file. + + An array of objects with information about the connection strings. + + + + Returns information about the available connection strings. + + An array of objects with information about the connection strings. + + + + Returns the specified connection string. + + The name of the connection string. + The connection string. + + + + Returns information about the specified connection string. + + The name of the connection string. + An object that contains information about a connection string. + + + + When implemented, returns a context object to obtain from the dependency injection container. + + + + + Returns the Entity Framework Core context for the specified data source. + + The name of an Entity Framework connection string. + The type of DbContext created by the factory. + The context object. + + + + Specifies how to resolve exceptions while performing an action. + + + + + Cancel the action that caused an exception. + + + + + Retry the action that caused an exception. + + + + + Contains classes that support the data filtering feature. + + + + + Enumerates aggregate functions. + + + + + Evaluates the average of the values in the collection. + + + + + Returns the number of objects in the collection. + + + + + Returns a custom aggregate function‘s result. + + + + + Determines whether the object exists in the collection. + + + + + Returns the maximum expression value in the collection. + + + + + Returns the minimum expression value in the collection. + + + + + Returns a single object from the collection. The collection must contain no more than one object. + + + + + Returns the sum of all the expression values in the collection. + + + + + An aggregate operator which calculates aggregate expressions (MIN, MAX, SUM, etc.) + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An object which represents the collection property. This value is assigned to the AggregateOperand.CollectionProperty property. + A object which represents the aggregated expression. This value is assigned to the AggregateOperand.AggregatedExpression property. + An enumeration value which specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + A object which represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the AggregateOperand.Condition property. + + + + Initializes a new instance of the class with specified settings. + + A value that specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + A collection of aggregated expressions to be assigned to the AggregateOperand.CustomAggregateOperands property. + A custom aggregate function‘s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A object that represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the AggregateOperand.Condition property. + + + + Initializes a new instance of the class. + + A value which specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + An enumeration value which specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + A object which represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the AggregateOperand.Condition property. + + + + Initializes a new instance of the class with the specified collection property and operator type. + + A value which specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + An enumeration value which specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + + + + Initializes a new instance of the class with the specified settings. + + A value which specifies the name of the collection property. It can be represented by a path through object relationships, for example “Employer.Addresses”. + A value which specifies the name of the persistent property of the object from the property collection. + An enumeration value which specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + A object which represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the AggregateOperand.Condition property. + + + + Initializes a new instance of the class with the specified settings. + + A value which specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + A value which specifies the name of the persistent property of the object from the property collection. + An enumeration value which specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + + + + Initializes a new instance of the class with specified settings. + + A value that specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + A custom aggregate function‘s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A object that represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the AggregateOperand.Condition property. + + + + Initializes a new instance of the class with specified settings. + + A value that specifies the name of the collection property whose values are used to calculate the aggregate expression. It can be represented by a path through object relationships, for example “Employer.Addresses”. + A custom aggregate function‘s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + + + + For internal use. + + + + + For internal use. + + + + + Gets or sets the aggregated expression. + + A object which represents the aggregated expression. + + + + Gets or sets the type of the aggregate operator. + + An enumeration value which specifies the type of the aggregate operator. + + + + Creates a new which returns the average of values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition. + + A object which specifies the aggregate expression. + An object which calculates an aggregate expression. + + + + Creates a copy of the current instance. + + An object which calculates an aggregate expression. + + + + Gets or sets a collection property whose elements are used to calculate an aggregate expression. + + An object which represents the collection property. + + + + Gets or sets the filter criteria which is applied to values. + + A object which represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. + + + + Creates a new which returns the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition. + + An object which calculates an aggregate expression. + + + + Creates a new which returns the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition. + + A object which specifies the aggregate expression. This parameter may be ignored in certain circumstances. + An object which calculates an aggregate expression. + + + + Creates a new custom that returns values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition. + + A custom aggregate function‘s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A collection of aggregated expressions to be assigned to the AggregateOperand.CustomAggregateOperands property. + An object which calculates an aggregate expression. + + + + Gets or sets a custom aggregate function‘s name. The property value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + + + + Gets an operand collection passed to a custom aggregate function. + + A collection of operand values. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Creates a new which determines whether or not the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition is greater than zero. + + An object which calculates an aggregate expression. + + + + Creates a new which determines whether or not the count of AggregateOperand.CollectionProperty elements that match the AggregateOperand.Condition is greater than zero. + + A object which specifies the aggregate expression. + An object which calculates an aggregate expression. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + true if the AggregateOperand.CollectionProperty is null reference; otherwise, false. + + + + Creates a new which returns the maximum of the values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition. + + A object which specifies the aggregate expression. This parameter may be ignored in certain circumstances. + An object which calculates an aggregate expression. + + + + Creates a new which returns the minimum of the values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition. + + A object which specifies the aggregate expression. + An object which calculates an aggregate expression. + + + + Creates a new which returns the single object from the AggregateOperand.CollectionProperty that matches the specified AggregateOperand.Condition. The collection must be empty or contain exactly one object. + + A object which specifies the aggregate expression. + An object which calculates an aggregate expression. + + + + Creates a new which returns the sum of values calculated by the given aggregate expression. This expression is evaluated against elements of the AggregateOperand.CollectionProperty that match the specified AggregateOperand.Condition. + + A object which specifies the aggregate expression. + An object which calculates an aggregate expression. + + + + Creates a new top-level that returns values calculated by the given custom aggregate expression. + + An enumeration value that specifies the type of the aggregate operator. This value is assigned to the AggregateOperand.AggregateType property. + An aggregated expression assigned to the AggregateOperand.AggregatedExpression property. + An operand collection passed to a custom aggregate function. + + + + Creates a new top-level that returns values calculated by the given custom aggregate expression. + + A custom aggregate function‘s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A collection of aggregated expressions to be assigned to the AggregateOperand.CustomAggregateOperands property. + An operand collection passed to a custom aggregate function. + + + + The base class that provides data for a Filter Control’s events. + + + + + Initializes a new instance of the class. + + The value used to initialize the PropertyName property. + The value used to initialize the PropertyType property. + + + + Gets the name of the current property (column/field). + + The property name (column/field name). + + + + Gets the type of the current property (column/field). + + The type of the current property (column/field). + + + + An operator which determines whether a criteria expression lies between the specified range of values. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified property and the specified range of values. + + A descendant which represents the expression that identifies the property whose values are tested. + A descendant which represents the expression for the lower value in the range. This value is assigned to the BetweenOperator.LeftOperand property. + A descendant which represents the expression for the upper value in the range. This value is assigned to the BetweenOperator.RightOperand property. + + + + Initializes a new instance of the class with the specified property and the specified range of values. + + A value which identifies the property whose values are tested. + A descendant which represents the expression for the lower value in the range. This value is assigned to the BetweenOperator.BeginExpression property. + A descendant which represents the expression for the upper value in the range. This value is assigned to the BetweenOperator.EndExpression property. + + + + Initializes a new instance of the class with the specified property name and the specified range of values. + + A value which specifies the name of the property whose values are tested. + A descendant which represents the expression for the lower value in the range. This value is assigned to the BetweenOperator.BeginExpression property. + A descendant which represents the expression for the upper value in the range. This value is assigned to the BetweenOperator.EndExpression property. + + + + Gets the expression for the first operand. + + A descendant which represents the expression for the lower value in the range. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Gets the expression for the second operand. + + A descendant which represents the expression for the upper value in the range. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets the expression for the first (left) operand. + + A descendant which represents the expression for the lower value in the range. + + + + Gets or sets the test expression. + + A descendant which represents the test expression. + + + + Gets the expression for the second (right) operand. + + A descendant which represents the expression for the upper value in the range. + + + + Gets or sets the test expression. + + A descendant which represents the test expression. + + + + A logical expression which consists of a operation between two operands. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified left and right operands and binary operator type. + + A descendant which represents the expression for the first operand. This value is assigned to the BinaryOperator.LeftOperand property. + A descendant which represents the expression for the second operand. This value is assigned to the BinaryOperator.RightOperand property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified values. + + A value which specifies the name of the property whose values are compared to the value. + An array of values to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to an array of values. + + A value which specifies the name of the property whose values are compared to the value. + An array of values to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to values. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified integer value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to integer values. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of the binary operator. + + A value which specifies the name of the property whose values are compared to the value. + An value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class. + + A value which specifies the name of the property whose values are compared to the value. + An value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of the binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to values. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Initializes a new instance of the class with the specified type of binary operator. This binary operator is used to compare the values of the specified property to the specified value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + A enumeration value which specifies the type of the binary operator. This value is assigned to the BinaryOperator.OperatorType property. + + + + Initializes a new instance of the class which is used to compare the values of the specified property to the value. + + A value which specifies the name of the property whose values are compared to the value. + The value to compare with the values of the specified property. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + The left operand. + + + + + Gets the type of the binary operator. + + + + + The right operand. + + + + + Enumerates binary operator types. + + + + + Represents the bitwise AND operator. + To create the bitwise AND operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 & 128 = 128”) + + + + + Represents the bitwise OR operator. + To create the bitwise OR operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 | 3”) + + + + + Represents the bitwise XOR operator. + To create the bitwise XOR operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“(Field1 ^ Field2) = 1”) + + + + + Represents the division operator. + To create the division operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 / Field2 = 2”) + + + + + Represents the Boolean equality operator. + To create the Boolean equality operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 = Field2”) + + + + + Represents the Boolean greater-than operator. + To create the Boolean greater-than operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 > Field2”) + + + + + Represents the Boolean greater-than-or-equal-to operator. + To create the Boolean greater-than-or-equal-to operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 >= Field2”) + + + + + Represents the Boolean less-than operator. + To create the Boolean less-than operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 < Field2”) + + + + + Represents the Boolean less-than-or-equal-to operator. + To create the Boolean less-than-or-equal-to operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 <= Field2”) + + + + + The LIKE operator. This operator behavior is different, depending on current circumstances. We recommend that you use StartsWith, Contains and EndsWith function operators instead of Like, where possible. + <!– + + To create the LIKE operator using the method use the following syntax: + + CriteriaOperator.Parse(“Field1 like ‘%val1%’ OR Field1 like ‘%val2%’”)–> + + + + + Represents the subtraction operator. + To create the subtraction operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 - Field2 = 10”) + + + + + Represents the modulus operator (computes the remainder after dividing its first operand by its second). + To create the modulus operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 % Field2 = 1”) + + + + + Represents the multiplication operator. + To create the multiplication operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 * Field2 = 100”) + + + + + Represents the Boolean inequality operator. + To create the Boolean inequality operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 != Field2”) or CriteriaOperator.Parse(“Field1 <> Field2”) + + + + + Represents the addition operator. + To create the addition operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 + Field2 = 20”) + + + + + A constant value operand in criteria expressions. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified constant value. + + The constant value for the operand. This value is assigned to the OperandValue.Value property. + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current object. + + + + An operator which checks if a collection contains at least one object matching a specific criteria. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified property operand and criteria expression. + + An object which represents the property operand in the criteria expression. + A object which represents the search criteria. + + + + Initializes a new instance of the class with the specified property and criteria expression. + + A value which identifies the property whose values will be searched. + A object that represents a search criteria. + + + + Provides the abstract (MustInherit in Visual Basic) base class for criteria operators. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns the expression which groups two operands with logical AND. + + A object which represents the first operand. + A object which represents the second operand. + A object representing the expression which groups two operands with logical AND. + + + + Returns the expression which groups the specified operands with logical AND. + + An array of objects that represent operands. + A object representing the expression which groups the specified operands with logical AND. + + + + Returns the expression which groups the specified operands with logical AND. + + A list of operands to be grouped. + A object representing the expression which groups the specified operands with logical AND. + + + + Creates a copy of the specified object. + + A object to clone. + A object which represents an exact copy of the specified object. null (Nothing in Visual Basic) if the specified object is null reference. + + + + Creates a copy of the specified object. + + An object to clone. + An object which represents an exact copy of the specified object. null (Nothing in Visual Basic) if the specified object is a null reference. + + + + This method is intended for internal use. + + + + + Returns the number of custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls. + + An integer value which specifies the number of elements in a collection returned by the CriteriaOperator.GetCustomFunctions function. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Converts an object to a string that can be used in criteria expressions. + + An object to convert. + A string that can be used in criteria expressions. + + + + Converts a property name to a string that can be used in criteria expressions. + + A property name to convert. + A string that can be used in criteria expressions. + + + + Converts the specified LINQ-like expression to its equivalent. + + A LINQ expression to convert. + A type of object to which the expression is applied. + A equivalent to the expression passed to the method’s parameter. + + + + Converts the specified LINQ-like expression to its equivalent. + + A LINQ expression to convert. + A type of object to which the expression is applied. + A type of object that is returned by the converted expression. + A equivalent to the expression passed to the method’s parameter. + + + + Searches custom aggregate functions registered in an application via the and method calls for a function with a specified name. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + An object that corresponds to the aggregateName, if found; otherwise, null (Nothing in Visual Basic). + + + + Searches custom aggregate functions registered in an application via the and method calls. + + A collection of all registered custom aggregtate functions. + + + + Searches custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls for a function with a specified name. + + The name of a custom function to search. You specify a custom function’s name by implementing the ICustomFunctionOperator.Name property. + An object that corresponds to the functionName, if found; otherwise, null (Nothing in Visual Basic). + + + + Returns custom functions registered in an application via the CriteriaOperator.RegisterCustomFunction and CriteriaOperator.RegisterCustomFunctions method calls. + + A DevExpress.Data.Filtering.CustomFunctionCollection object containing all custom functions registered via the methods mentioned above. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Initializes a new UnaryOperator instance that checks whether the current criteria is not null. + + An unary operator that checks whether the current criteria is not null + + + + Initializes a new UnaryOperator instance that checks whether the current criteria is null. + + An unary operator instance that checks whether the current criteria is null + + + + Returns the string representation of the criteria specified by the current instance. + + A string equivalent of the current instance. + + + + Returns the string representation of a specified criteria. + + A instance specifying the criteria used to convert to a string equivalent. + A string equivalent of the criteria. + + + + Returns an instance of the that represents the criterion resulting from the logical inversion of the criterion the current represents. + + An instance of the that represents the criterion resulting from the logical inversion of the criterion the current represents. + + + + Returns the expression which groups two operands with logical OR. + + A object which represents the first operand. + A object which represents the second operand. + A object representing the expression which groups two operands with logical OR. + + + + Returns the expression which groups the specified operands with logical OR. + + An array of objects that represent operands. + A object representing the expression which groups the specified operands with logical OR. + + + + Returns the expression which groups the specified operands with logical OR. + + A list of operands to be grouped. + A object representing the expression which groups the specified operands with logical OR. + + + + Converts the specified string, specifying an expression, to its equivalent. + + A value, that is the expression to convert. + [out] Receives the values that are substituted into the expression in place of question mark characters. These parameters can be omitted. + A equivalent to the expression contained in criteria. + + + + Converts the specified string, specifying an expression, to its equivalent. + + A value, that is the expression to convert. + The values that are substituted into the expression in place of question mark characters. These parameters can be omitted. + A equivalent to the expression contained in criteria. + + + + Converts the specified string representation of expressions that are divided by a semicolon into their equivalents. + + A value that represents the expressions to convert. The expressions are divided by a semicolon. + [out] Receives the values that are substituted into the expression in place of question mark characters. These parameters can be omitted. + An array of equivalents to the expressions contained in criteriaList. + + + + Converts the specified string representation of expressions that are divided by a semicolon into their equivalents. + + A value that represents the expressions to convert. The expressions are divided by a semicolon. + The values that are substituted into the expression in place of question mark characters. These parameters can be omitted. + An array of equivalents to the expressions contained in criteriaList. + + + + Registers a custom aggregate function to use in any -based criteria in your application. + + A custom aggregate function to register. + + + + Registers custom aggregate functions to use in any -based criteria in your application. + + A collection of custom aggregate functions to register. + + + + Registers a specified custom function to use in any -based criteria in your application. + + An object specifying a custom function to register. + + + + Registers specified custom functions to use in any -based criteria in your application. + + A collection of objects specifying custom functions to register. + + + + Converts the specified expression into its equivalent string in VB style. + + A object that represents the expression to convert. + [out] Receives the values that are marked by a question mark character in the result string. + A string representation of the specified expression. + + + + Converts the specified expression into its equivalent string in VB style. + + A object that represents the expression to convert. + A string representation of the specified expression. + + + + Converts the specified expression into its equivalent string in C# style. + + A object that represents the expression to convert. + [out] Receives the values that are marked by a question mark character in the result string. + A string representation of the specified expression. + + + + Converts the specified expression into its equivalent string in C# style. + + A object that represents the expression to convert. + A string representation of the specified expression. + + + + Converts the current expression into its VB equivalent string. + + A string representation of this expression. + + + + Converts the specified expression into its equivalent string in VB style. + + A object that represents the expression to convert. + [out] Receives the values that are marked by question mark character in the result string. + A string representation of the specified expression. + + + + Converts the specified expression into its equivalent string in VB style. + + A object that represents the expression to convert. + A string representation of the specified expression. + + + + Tries to convert the specified string representation of an expression to its equivalent. + + A value that represents the expression to convert. + The values that are substituted into the expression in place of question mark characters. These parameters can be omitted. + A equivalent to the expression contained in criteria. + + + + Unregisters a specified custom aggregate function from use in any -based criteria in your application. + + A custom aggregate function to unregister. + true, if a custom aggregate function was unregistered; otherwise, false. + + + + Unregisters a custom aggregate function with a specified name from use in any -based criteria in your application. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + true, if a custom aggregate function was unregistered; otherwise, false. + + + + Unregisters a specified custom function from use in any -based criteria in your application. + + An object instance specifying a custom function to unregister. + true if the customFunction has successfully been removed from a collection returned by the CriteriaOperator.GetCustomFunctions function; otherwise, false. + + + + Unregisters a custom function with a specified name from use in any -based criteria in your application. + + The name of a custom function to unregister. + true if a custom function whose name matches the functionName has successfully been removed from a collection returned by the CriteriaOperator.GetCustomFunctions function; otherwise, false. + + + + Occurs when restoring a serialized criteria operator that references a user object. + + + + + Occurs when serializing a criteria operator that references a user object. + + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified initial capacity. + + The number of elements that the new CriteriaOperatorCollection can initially store. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Returns a string that represents the current object. + + A that represents the current object. + + + + Represents a collection to store a list of custom aggregate functions. + + + + + Creates a new instance of the class. + + + + + Adds a specified custom aggregate function to the custom aggregate function collection. + + A custom aggregate function to be added to the custom aggregate function collection. + + + + Adds specified custom aggregate functions to the custom aggregate function collection. + + Custom aggregate function items to be added to the custom aggregate function collection. + + + + Clears a custom aggregate function collection. + + + + + Finds out whether a custom aggregate function collection contains a specified item. + + A custom aggregate function. + true, if the collection contains a specified custom aggregate function; otherwise, false. + + + + Copies an array of custom aggregate functions to a specified location in an array. + + An array of custom aggregate functions. + A specified location in an array. + + + + Gets the number of custom aggregate functions a collection contains. + + A number of custom aggregate functions in a collection. + + + + Searches custom aggregate functions registered in an application via the and method for a function with the specified name. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A custom aggregate function. + + + + For internal use. + + + + + Removes a specified custom aggregate function from a custom aggregate function collection. + + A custom aggregate function to be removed from the collection. + true, if a specified custom aggregate was successfully removed from the collection; otherwise, false. + + + + Can be used as a value type context in , , and methods. + + The custom aggregate function context’s value type. + + + + Initializes a new class instance. + + + + + Procecces the as directed in the parameter. + + A delegate that processes the . + A that is the result of the processFunction. + + + + Gets of sets the value type for . + + The value stored in the context. + + + + Provides helper methods used to register enumeration types whose values can be serialized in Criteria Language expressions. + + + + + Enables serialization of the specified enumeration type values in Criteria Language expressions. + + A object specifying the type of enumeration to be registered. + A string that specifies the enumeration name to be used in criteria instead of FullName. + + + + Enables serialization of the specified enumeration type’s values in Criteria Language expressions. + + A object specifying the type of enumeration to be registered. + + + + Enables serialization of the specified enumeration type’s values in Criteria Language expressions. + + + + + Enables serializing values of enumerations from all assembies that are loaded to the current application domain in Criteria Language expressions. + + + + + Enables serializing values of all enumerations from the specified assembly in Criteria Language expressions. + + A object that specifies the assembly containing enumerations to be registered. + true, if enumerations from referenced assemblies are ignored; otherwise, false. + + + + Enables serializing values of all enumerations from the specified assembly in Criteria Language expressions. + + A object that specifies the assembly containing enumerations to be registered. + + + + Enables serializing values of all enumerations from the specified assemblies in Criteria Language expressions. + + A [] array that specifies assemblies containing enumerations to be registered. + true, if enumerations from referenced assemblies are ignored; otherwise, false. + + + + Enables serializing values of all enumerations from the specified assemblies in Criteria Language expressions. + + A [] array that specifies assemblies containing enumerations to be registered. + + + + Contains classes that describe exceptions which may occur when filtering data. + + + + + An exception that is thrown when a string that represents criteria cannot be parsed. + + + + + Initializes a new instance of the class. + + A string that specifies the error description. + A value of the CriteriaLexer.Line property that specifies the line where an exception occured. This value is used to initialize the CriteriaParserException.Line property. + A value of the CriteriaLexer.Col property that specifies the column where an exception occured. This value is used to initialize the CriteriaParserException.Column property. + + + + Initializes a new instance of the class. + + A string that specifies the error description. + + + + The value of the CriteriaLexer.Col property that specifies the column where an exception occured. + + The value of the CriteriaLexer.Col property that specifies the column where an exception occured. + + + + A value of the CriteriaLexer.Line property that specifies the line where an exception occured. + + A value of the CriteriaLexer.Line property that specifies the line where an exception occured. + + + + An exception that is thrown when a specific property that is used in a specific expression cannot be resolved. + + + + + Initializes a new instance of the class. + + A string that specifies the error description. + + + + Contains enumeration values that specify comparison operation types used to create filter conditions. + + + + + Specifies the Contains comparison operation. + + + + + Specifies the default comparison operation. + + + + + Specifies the Equals comparison operation. + + + + + Specifies the Like comparison operation. + + + + + Specifies the StartsWith comparison operation. + + + + + Contains values that specify how a control’s Find Panel combines entered words to create a search query. + + + + + Words are combined by the ‘AND’ operator. + The operator changes to ‘OR’ when you precede a word with the ‘?’ character. + The operator changes to ‘NOT’/‘AND NOT’ when you precede a word with the ‘-‘ sign. The ‘?administrator ?Maria Sweden -Owner‘ is treated as ‘Sweden AND (administrator OR Maria) AND NOT Owner‘ + + + + + Allows you to implement a custom parser by handling a control’s ParseFindPanelText event. + + + + + When the WindowsFormsSettings.FindPanelParserKind setting equals Default, this value is interpreted as And. If you set the WindowsFormsSettings.DefaultSettingsCompatibilityMode property to v18_2 or an earlier version, the Default value is interpreted as Mixed. + When a control’s ParserKind property is set to Default, the WindowsFormsSettings.FindPanelParserKind setting specifies the actual behavior for this control. + + + + + The exact match. If the entered string contains the space characters, the words are not treated separately. + + + + + Words are combined by the ‘OR’ operator. The operator changes to ‘AND’ if you specify a column name before a search word. The ‘administrator owner Country:Sweden‘ string is treated as ‘(administrator OR owner) AND Sweden(in the Country column)‘ + + + + + Words are combined by the ‘OR’ operator. The operator changes to ‘AND’ when you precede a word with the ‘+’ sign. The ‘administrator Maria +Sweden‘ string is treated as the ‘Sweden AND (administrator OR Maria)‘ query. + + + + + Lists the values that specify categories for functions available in Expression Editors. + + + + + Identifies functions that fall into any of the other categories. + + + + + Identifies functions that work with date-time values. + + + + + Identifies functions that perform logical operations. + + + + + Identifies functions that perform math operations. + + + + + Identifies functions that work with strings. + + + + + A function operator based on a . + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the default settings. + + A value that specifies the type of function. This value is used to initialize the FunctionOperator.OperatorType property. + An array of objects that specify the operands required by the selected function. This value is used to initialize the FunctionOperator.Operands property. + + + + Initializes a new instance of the class with the specified parameters. + + A enumeration value that specifies the type of function. This value is used to initialize the FunctionOperator.OperatorType property. + An object that implements the IEnumerable interface and represents a collection of objects which specify the operands required by the selected function. This value is used to initialize the FunctionOperator.Operands property. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A value, specifying the name of the custom function. + A collection of the objects. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + This method is intended for internal use. + + + + + Provides access to the object that represents a collection of the operands used to construct the current . + + A object that represents a collection of the operands used to construct the current . + + + + Represents the function type. + + The operands are specified by the FunctionOperator.Operands property and these can be initialized in the constructor. Each operand represents an instance of the class descendant, the number of operands depends on the function type. + + + + + Enumerates function types that can be used by the operators. + + + + + Returns the absolute value of a numeric operand. + If the operand is not numeric, the is thrown. + + + + + Returns the arccosine of the numeric operand. The arccosine is the angle in the range 0 (zero) to π radians, whose cosine is the numeric operand. + If the operand cannot be converted to , the is thrown. + + + + + Returns a value that is the specified number of days before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the number of days before or after the start date. This number can be negative or positive. Its decimal part is a fraction of a day. + + + + + Returns a value that is the specified number of days before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the number of hours before or after the start date. This number can be negative or positive. Its decimal part is a fraction of an hour. + + + + + Returns a value that is the specified number of milliseconds before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the number of milliseconds before or after the start date. This number can be negative or positive. Its decimal part is a fraction of a millisecond. + + + + + Returns a value that is the specified number of minutes before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the number of minutes before or after the start date. This number can be negative or positive. Its decimal part is a fraction of a minute. + + + + + Returns a value that is the specified number of months before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the integer value that is the number of months before or after the start date. This number can be negative or positive. + + + + + Returns a value that is the specified number of seconds before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the number of seconds before or after the start date. This number can be negative or positive. Its decimal part is a fraction of a second. + + + + + Returns a value that is the specified number of ticks before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the integer number that is the number of 100-nanosecond ticks. This number can be negative or positive. + + + + + Returns a value that differs by a specified amount of time from a specified date. + The operands are: + 1 - the value that is the start date. + 2 - the object that is the time period before or after the start date. + + + + + Returns a value that is the specified number of years before or after a specified start date. + The operands are: + 1 - the value that is the start date. + 2 - the integer value that is the number of years before or after the start date. This number can be negative or positive. + + + + + Returns the ASCII code of the first character in a string operand. + If the argument is an empty string, the null value is returned. + + + + + Returns the arcsine of the numeric operand. The arcsine is the angle in the range -π/2 to π/2 radians, whose sine is the numeric operand. + If the specified operand cannot be converted to , the is thrown. + + + + + Returns the arctangent (the inverse tangent function) of the numeric operand. The arctangent is the angle in the range -π/2 to π/2 radians, whose tangent is the numeric operand. + If the operand cannot be converted to , the is thrown. + + + + + Returns the arctangent (the inverse tangent function) of the quotient of the two specified numeric operands. The arctangent is the angle in the range -π/2 to π/2 radians. + The operands are: + 1 - the y coordinate of a point in Cartesian coordinates (x, y). + 2 - the x coordinate of a point in Cartesian coordinates (x, y). + If the specified operands cannot be converted to , the is thrown. + + + + + Calculates the full product of two integer operands. + If the specified operands cannot be converted to , the is thrown. + + + + + Returns the smallest integral value greater than or equal to the specified numeric operand. + If the specified operand is not numeric, the is thrown. + + + + + Converts a numeric operand to a Unicode character. + If the specified operand is not numeric, the is thrown. + + + + + Returns the index of the first occurrence of a specified string within another string. + The operands are: + 1 - a string that you want to find in another string. + 2 - a string that contains the string you are searching for. + 3 - (optional) an integer that specifies the zero-based index at which the search starts. If this operand is not specified, the search begins from the start of the string. + 4 - (optional) an integer that specifies the number of characters to examine, starting from the specified position. If this operand is not specified, the search continues until the end of the string. + This function performs a word (case-sensitive and culture-sensitive) search using the current culture. If a specified substring is found, the function returns its index. Otherwise, -1 is returned. + + + + + Concatenates the specified strings. + + + + + Returns True if the specified string occurs within another specified string; otherwise, False. + The operands are: + 1 - a string that contains the string you are searching for. + 2 - a string that you want to find in another string. + + + + + Returns the cosine of the numeric operand, in radians. + If the operand cannot be converted to , the is thrown. + + + + + Returns the hyperbolic cosine of the numeric operand, in radians. + If the operand cannot be converted to , the is thrown. + + + + + Identifies a custom operation. This operation is executed on the client side if its operands are constants. A custom operation is executed on the server side only if its operands cannot be evaluated locally. For more information on how to implement custom operators, review the following help topic: How to: Implement a Custom Criteria Language Function Operator. + The eXpress Persistent Objects framework provides two custom function operators - and . + + + + + Identifies a custom nondeterministic operation. + Unlike a standard custom operation, a custom nondeterministic operation is always executed on the server side, regardless of whether its operands are constants. + For more information on how to implement custom operators, review the following help topic: How to: Implement a Custom Criteria Language Function Operator. + + + + + Returns the number of day boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of hour boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of millisecond boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of minute boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of month boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of second boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of tick boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns the number of year boundaries between the specified dates. + The operands are: + 1 - the value that is the start date. + 2 - the value that is the end date. + + + + + Returns a date value constructed from the specified Year, Month, Day, Hour, Minute, Second, and Millisecond. + The operands are: + 1 - (Required) - an integer value that is the full year value (four digits, century included). + 2 - (Required) - an integer value that is the month number (1-12). + 3 - (Required) - an integer value that is the day of the month (1-31). + 4 - (Optional) - an hour value in 24-hour format (0-23). + 5 - (Optional) - a minute value (0-59). + 6 - (Optional) - a second value (0-59). + 7 - (Optional) - a millisecond value. + + + + + Returns True if the end of one specified string matches another specified string; otherwise, False. + The operands are: + 1 - a string that contains the string you are searching for. + 2 - a string to compare to the substring at the end of another string. + To create the EndsWith operator using the CriteriaOperator.Parse method, use the following syntax: CriteriaOperator.Parse("EndsWith(String, SubString)"). + + + + + Returns the number e raised to the power specified by a numeric operand. + If the specified operand cannot be converted to , the is thrown. + The Exp function reverses the FunctionOperatorType.Log function. Use the FunctionOperatorType.Power operand to calculate powers of other bases. + + + + + Returns the largest integral value less than or equal to the specified numeric operand. + If the specified operand is not numeric, the is thrown. + + + + + Returns the date part of the specified date. + The operand must be of the type. + The return value is a object with the same date part. The time part is 00:00:00. + + + + + Gets the day of the month in the specified date. + The operand must be of the type. + The return value is an integer in the range between 1 and 31. + + + + + Gets the day of the week in the specified date. + The operand must be of the type. + The return value is an integer value of the enumeration. It does not depend on the current culture. + + + + + Gets the day of the year in the specified date. + The operand must be of the type. + The return value is an integer in the range between 1 and 366. + + + + + Returns the hours value in the specified date. + The operand must be of the type. + The return value is an integer in the range between 0 and 23. + + + + + Returns the milliseconds value in the specified date. + The operand must be of the type. + The return value is an integer in the range between 0 and 999. + + + + + Returns the minutes value in the specified date. + The operand must be of the type. + The return value is an integer in the range between 0 and 59. + + + + + Gets the month in the specified date. + The operand must be of the type. + The return value is an integer and depends on the current calendar. + + + + + Returns the seconds value in the specified date. + The operand must be of the type. + The return value is an integer in the range between 0 and 59. + + + + + Gets the time part of the specified date. + The operand must be of the type. + The return value is the object that is the number of 100-nanosecond ticks that have elapsed since midnight. + + + + + Gets the year in the specified date. + The operand must be of the type. + The return value is an integer in the range between 1 and 9999. + + + + + Returns one of the specified values depending upon the values of logical expressions. + The function can take 2N+1 arguments (where N is the number of specified logical expressions): + + + + + + Examples: + Iif(Name = 'Bob', 1, 0) + Iif(Name = 'Bob', 1, Name = 'Dan', 2, Name = 'Sam', 3, 0) + + + + + Returns a new string in which a specified string is inserted at a specified index position into another specified string. + The operands are: + 1 - the string into which another string should be inserted. + 2 - the zero-based index position of the insertion. + 3 - the string to insert. + + + + + Returns True if the specified date falls within April. + + + + + Returns True if the specified date falls within August. + + + + + Returns True if the specified date falls within December. + + + + + Returns True if the specified date falls within February. + + + + + Returns True if the specified date falls within January. + + + + + Returns True if the specified date falls within July. + + + + + Returns True if the specified date falls within June. + + + + + Returns True if the specified date falls within the previous month. + + + + + Returns True if the specified date falls within the previous year. + + + + + Returns True if the specified date falls within March. + + + + + Returns True if the specified date falls within May. + + + + + Returns True if the specified date falls within the next month. + + + + + Returns True if the specified date falls within the next year. + + + + + Returns True if the specified date falls within November. + + + + + Compares the first operand with the NULL value. + This function requires one or two operands of the class. The returned value depends on the number of arguments. + If a single operand is passed, the function returns True if the operand is null; otherwise, False. + If two operands are passed, the function returns the second operand if the first operand is null. Otherwise, the function returns the first operand. + + + + + Returns True if the specified value is null or an empty string. Otherwise, returns False. + + + + + Returns True if the specified date falls within October. + + + + + The Boolean Is Beyond This Year operator for date/time values. Requires one argument. + The operator is defined as follows: date >= First Day of Next Year + + + + + The Boolean Is Earlier This Month operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of This Month <= date < First Day of Last Week + + + + + The Boolean Is Earlier This Week operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of This Week <= date < Yesterday + + + + + The Boolean Is Earlier This Year operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of This Year <= date < First Day of This Month + + + + + The Boolean Is Last Week operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of Last Week <= date < First Day of This Week + + + + + The Boolean Is Later This Month operator for date/time values. Requires one argument. + The operator is defined as follows: Last Day of Next Week < date < First Day of Next Month + + + + + The Boolean Is Later This Week operator for date/time values. Requires one argument. + The operator is defined as follows: Day After Tomorrow <= date < First Day of Next Week + + + + + The Boolean Is Later This Year operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of Next Month <= date < First Day of Next Year + + + + + The Boolean Is Next Week operator for date/time values. Requires one argument. + The operator is defined as follows: First Day of Next Week <= date <= Last Day of Next Week + + + + + The Boolean Is Prior This Year operator for date/time values. Requires one argument. + The operator is defined as follows: date < First Day of This Year + + + + + The Boolean Is Today operator for date/time values. Requires one argument. + + + + + The Boolean Is Tomorrow operator for date/time values. Requires one argument. + + + + + The Boolean Is Yesterday operator for date/time values. Requires one argument. + + + + + Returns True if the specified date/time value falls within the same day. + To create the IsSameDay operator using the CriteriaOperator.Parse method, use the following syntax: CriteriaOperator.Parse(“IsSameDay(StartDate)”). + + + + + Returns True if the specified date falls within September. + + + + + Returns True if the specified date falls within the current month. + To create the IsThisMonth operator using the CriteriaOperator.Parse method, use the following syntax: CriteriaOperator.Parse(“IsThisMonth(StartDate)”). + + + + + Returns True if the specified date falls within the current week. + + + + + Returns True if the specified date falls within the current year. + + + + + Returns True if the specified date falls within the period that starts from the first day of the current year and continues until the current date (including the current date). + + + + + Returns the length of the string specified by an operand. + To create the Len operator using the CriteriaOperator.Parse method, use the following syntax: CriteriaOperator.Parse("Len(Field1)"). + + + + + Returns the value that has the date part that is two days after the current date, and the time part of 00:00:00. + + + + + Returns the value that has the date part that is one month before the current date, and the time part of 00:00:00. + + + + + Returns the value that has the date part that is 7 days before the start of the current week, and the time part of 00:00:00. + + + + + Returns the value that has the date part that is the first day of the previous year, and the time part of 00:00:00. + + + + + Returns the value that has the date part that is the first day of the next month, and the time part of 00:00:00. + + + + + Returns the value that has the date part that is 7 days after the start of the current week, and the time part of 00:00:00. + + + + + Returns the value with the date part that corresponds to the first day of the next year, and the time part of 00:00:00. + + + + + Returns the value that is the current moment in time. + + + + + Returns the value with the date part that is the first day of the current month, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the first day of the current week, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the first day of the current year, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the start of the current day, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the next day, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the first day of the month after the next month, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the first day of the week after the next week, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the first day of the year after the next year, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the date one year ago, and the time part of 00:00:00. + + + + + Returns the value with the date part that is the previous day, and the time part of 00:00:00. + + + + + Returns the logarithm of the specified numeric operand. The return value depends upon the number of operands. + If one operand is passed, the function returns the natural (base e) logarithm of a specified operand. + If two operands are passed, the function returns the logarithm of the specified operand to the specified base. The operands are: + 1 - a number whose logarithm is to be calculated. + 2 - the base of the logarithm. + If the operand cannot be converted to , the is thrown. + The Log function reverses the FunctionOperatorType.Exp function. To calculate the base-10 logarithm, use the FunctionOperatorType.Log10 function. + + + + + Returns the base 10 logarithm of the specified numeric operand. + If the operand cannot be converted to , the is thrown. + The Log10 function reverses the FunctionOperatorType.Power function. Use the FunctionOperatorType.Log operand to calculate the logarithm of other bases. + + + + + Converts all characters in a string operand to lowercase in an invariant culture. + + + + + Returns the larger of two numeric values. + + + + + Returns the smaller of two numeric values. + + + + + The function type is not specified. + + + + + Returns the value that is the current date and time. + + + + + Returns a new string that pads the character in the specified string on the left with a specified Unicode character, for a specified total length. + The operands are: + 1 - a string to be padded. + 2 - the total number of characters in the resulting string, including padding characters. + 3 - (optional) a Unicode padding character. If not specified, the space character is used for padding. If a string is passed as this operand, its first character is used for padding. + + + + + Returns a new string of a specified length in which the end of a specified string is padded with spaces or with a specified Unicode character. + The operands are: + 1 - a string to be padded. + 2 - the total number of characters in the resulting string, including padding characters. + 3 - (optional) a Unicode padding character. If not specified, the space character is used for padding. If a string is passed as this operand, its first character is used for padding. + + + + + Returns a specified numeric operand raised to a specified power. + The operands are: + 1 - the base number. + 2 - the exponent to which the base number is raised. + If the operand cannot be converted to , the is thrown. + The Power function reverses the FunctionOperatorType.Log or FunctionOperatorType.Log10 function. Use the FunctionOperatorType.Exp operand to calculate powers of the number e. + + + + + Returns a new string with the specified number of characters in the specified string removed, starting at the specified position. + The operands are: + 1 - the string that needs to be shortened. + 2 - the zero-based index at which character removal starts. + 3 - (optional) an integer that specifies the number of characters to remove, starting at the specified position. If this operand is not specified, all characters between the starting position and the end of the string are removed. + + + + + Returns a new string in which all occurrences of one specified string (string1) in another string (string2) are replaced with the specified string (string3). + The operands are: + 1 - the string in which replacements are made. + 2 - the string to be replaced. + 3 - the string to replace all occurrences of the specified string. + + + + + Returns a string in which the character order of a specified string is reversed. + + + + + Returns a random number greater than or equal to 0.0, and less than 1.0. + + + + + Rounds a specified numeric operand to the nearest integer or to a specified number of fractional digits. + The operands are: + 1 - a value to round. + 2 - (optional) the number of decimal places to which to round. 0 indicates that the first operand is rounded to the nearest integer. + + + + + Returns an integer that indicates the sign of a number. The function returns 1 for positive numbers, -1 for negative numbers, and 0 (zero) if a number is equal to zero. + If a specified operand is not numeric, the is thrown. + + + + + Returns the sine of the numeric operand, in radians. + If the operand cannot be converted to , the is thrown. + + + + + Returns the hyperbolic sine of the numeric operand, in radians. + If the operand cannot be converted to , the is thrown. + + + + + Returns the square root of a specified numeric operand. + If the operand cannot be converted to , the is thrown. + + + + + Returns True if the beginning of one string matches another string; otherwise, False. + The operands are: + 1 - a string to test. + 2 - a string to match the beginning of another string. + + + + + Returns a substring from the specified string. This function requires two or three operands. + If two operands are passed, the substring starts from the beginning of the specified string. + The operands are: + 1 - the source string. + 2 - an integer that specifies the zero-based position at which the substring starts. + If three operands are passed, a substring starts from the specified position in the source string. The operands are: + 1 - the source string. + 2 - an integer that specifies the zero-based position at which the substring starts. + 3 - an integer that specifies the length of the substring. + + + + + Returns the tangent of the specified numeric operand that is an angle in radians. + If the operand cannot be converted to , the is thrown. + + + + + Returns the hyperbolic tangent of a specified numeric operand that is an angle in radians. + If the specified operands cannot be converted to , the is thrown. + + + + + Returns a value that is the current date. The time part is set to 00:00:00. + + + + + Converts a numeric operand to a decimal value. + + + + + Converts a numeric operand to a double value. + + + + + Converts a numeric operand to a floating-point value. + + + + + Converts a numeric operand to an integer value. + + + + + Converts a numeric operand to a long integer value. + + + + + Returns a string representation of the specified value or property. + If the operand cannot be converted to a string, the is thrown. + + + + + Returns a string that is a copy of the specified string with all white-space characters removed from the start and end of the specified string. + + + + + Converts all characters in a string operand to uppercase in an invariant culture. + + + + + Returns a object that is the current date and time in Universal Coordinated Time (UTC). + + + + + A logical expression which groups two or more operands with a logical AND or OR. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified operands. + + An array of the objects that represent operands. This value is assigned to the GroupOperator.Operands property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the type of the group operator. This value is assigned to the GroupOperator.OperatorType property. + An array of objects that represent operands. This value is assigned to the GroupOperator.Operands property. + + + + Initializes a new instance of the with the specified parameters. + + A enumeration value that specifies the type of the group operator. This value is assigned to the GroupOperator.OperatorType property. + An object that implements the IEnumerable interface and represents a collection of objects which specify the operands required by the selected function. This value is used to initialize the FunctionOperator.Operands property. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Returns the expression which groups two operands with logical AND or OR. + + A enumeration value that specifies the type of the group operator. + A object which represents the first operand. + A object which represents the second operand. + A object representing the expression which groups two operands. + + + + Returns the expression which groups the specified operands with logical AND or OR. + + A enumeration value that specifies the type of the group operator. + An array of objects that represent operands. + A object representing the expression which groups the specified operands. + + + + Returns the expression which groups the specified operands with logical AND or OR. + + A enumeration value that specifies the type of the group operator. + A list of operands to be grouped. + A object representing the expression which groups the specified operands. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Provides access to the object that represents a collection of the operands used to construct the current . + + A object that represents a collection of the operands used to construct the current . + + + + Specifies the type of the group operator. The available types are enumerated in the enumeration. + + + + + Enumerates group operator types. + + + + + Groups operands with logical AND. + To create the logical AND operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 > 100 AND Field2 < 150”) + + + + + Groups operands with logical OR. + To create the logical OR operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 > 100 OR Field2 < 150”) + + + + + Contains utility classes that relate to the filtering functionality. + + + + + Lists the values that define the types of filter criteria used in the Automatic Filter Row. + + + + + Specifies the Any Of filter criteria. + + + + + Specifies the Begins With filter criteria. + + + + + Specifies the Between filter criteria. + + + + + Specifies the Contains filter criteria. + + + + + Specifies the Does Not Contain filter criteria. + + + + + Specifies the Does Not Equal filter criteria. + + + + + Specifies the Ends With filter criteria. + + + + + Specifies the Equals filter criteria. + + + + + Specifies the Greater filter criteria. + + + + + Specifies the Greater Or Equal filter criteria. + + + + + Specifies the Is Beyond This Year filter criteria. + + + + + Specifies the Is Earlier This Month filter criteria. + + + + + Specifies the Is Earlier This Week filter criteria. + + + + + Specifies the Is Earlier This Year filter criteria. + + + + + Specifies the Is Last Week filter criteria. + + + + + Specifies the Is Later This Month filter criteria. + + + + + Specifies the Is Later This Week filter criteria. + + + + + Specifies the Is Later This Year filter criteria. + + + + + Specifies the Is Next Week filter criteria. + + + + + Specifies the Is Not Null filter criteria. + + + + + Specifies the Is Not Null Or Empty filter criteria. + + + + + Specifies the Is Null filter criteria. + + + + + Specifies the Is Null Or Empty filter criteria. + + + + + Specifies the Is Prior This Year filter criteria. + + + + + Specifies the Is Today filter criteria. + + + + + Specifies the Is Tomorrow filter criteria. + + + + + Specifies the Is Yesterday filter criteria. + + + + + Specifies the Less filter criteria. + + + + + Specifies the Less Or Equal filter criteria. + + + + + Specifies the Like filter criteria. + + + + + Specifies the None Of filter criteria. + + + + + Specifies the Not Between filter criteria. + + + + + Specifies the Not Like filter criteria. + + + + + Provides information about an error that occurred during criteria validation. + + + + + Initializes a new instance of the class with the specified error text. + + A value, specifying the error text. This value is assigned to the CriteriaValidatorError.Text property. + + + + Returns the error message. + + A value, specifying the error text. + + + + Enables you to manage the collection of errors found during criteria validation in the Expression Editor. + + + + + Initializes a new instance of the class with the specified collection of bound properties. + + A collection of objects implementing the interface. + + + + Removes all items from the collection of validation errors. + + + + + Returns the number of errors found in an expression. + + An integer value, specifying the number of errors found in an expression. + + + + Returns the specified item from the collection of validation errors. + + An integer value, specifying the item’s position within the collection. + A object. + + + + For internal use. + + A object. + + + + For internal use. + + An object implementing the interface. + + + + For internal use. + + A value, specifying the filter string. + + + + Enables custom processing of the specified . + + An object. + + + + Enables custom processing of the specified . + + A object. + + + + Enables custom processing of the specified . + + A object. + + + + Enables custom processing of the specified . + + A object. + + + + Enables custom processing of the specified . + + A object. + + + + Enables custom processing of the specified . + + An object. + + + + Enables custom processing of the specified . + + A object. + + + + Enables custom processing of the specified . + + An object. + + + + Enables custom processing of the specified . + + An object. + + + + Enables custom processing of the specified . + + A object. + + + + For internal use only. + + + + + For internal use only. + + + + + Declares the base functionality for custom aggregate functions. + + + + + An object that stores the result’s intermediate state between the method calls. + + An object that stores the result’s intermediate state between the method calls. + + + + Gets a custom aggregate function‘s result. + + An object that stores the result’s intermediate state between the method calls. + A custom aggregate function’s result. + + + + When implemented by a custom aggregate function, specifies its name. + + The custom aggregate’s name use to identify a custom aggregate function. + + + + Is called to process every element of a collection supplied to a custom aggregate function. + + An object that stores the result’s intermediate state between method calls. + An operand array to be supplied to an aggregate function. + true, if no more elements need to be processed and the final result was acquired, otherwise, false. + + + + When implememnted by a custom aggregate function, determines its return value type based on the type of aggregate function parameters. + + An array of aggregate function parameter types. + A object that specifies the custom aggregate function’s return value type. + + + + Allows you to define a description of a custom aggregate function that appears in the Expression Editor, and validate the number of arguments and their type. + + + + + Specifies the function description that appears in the Expression Editor. + + Text that describes the function’s purpose and syntax. + + + + Determines whether the specified number of operands is acceptable. + + An integer value that is the number of operands (parameters) passed to a custom function. + true if the number of operands (parameters) is valid for a custom function; otherwise, false. + + + + Determines whether a function accepts an argument (operand) of the specified type. + + A zero-based integer value that is the operand’s index in the list of operands. + An integer value that is the total number of operands passed to a custom function. + A object that is the operand’s type. + true if a custom aggregate function accepts the operand of the specified type; otherwise, false. + + + + Returns the maximum number of operands (parameters) that this function can accept. + + An integer value that is the maximum number of operands (parameters) that the custom function can accept. -1 indicates that a custom function accepts an infinite number of operands. + + + + Returns the minimum number of operands (parameters) that this function requires. + + An integer value that is the smallest possible number of operands (parameters) that the user function requires. 0 indicates that operands can be omitted. + + + + Implemented by custom aggregate functions that can be converted to a LINQ expression. + + + + + When implemented by a custom aggregate function, converts it to a Linq expression. + + An DevExpress.Data.Linq.Helpers.ICriteriaToExpressionConverter object that converts a criteria to an expression. + An Expression that returns a collection used to calculate a custom aggregate. + An Expression that returns a collection’s item that provides arguments for the custom aggregate function. + An array of Expressions that specify aggregate function operands. + An Expression object that specifies a LINQ expression. + + + + Defines server-side processing for custom aggregate functions. + + + + + Builds a SQL command that calculates a custom aggregate function result on the server side. + + A object that specifies a data store (database) provider. For example, . + An array of operands passed to a custom aggregate function. + A SQL command that substitutes a custom aggregate function’s calls in query statements. + + + + Allows you to create a custom function displayed as a comparison operator and specify the operator’s display settings. + + + + + Specifies the operator’s caption. + + The operator’s caption. + + + + Specifies the operator’s image. + + An image instance. + + + + Declares the base functionality for custom functions. + + + + + When implemented by a custom function, evaluates it on the client. + + An array of objects specifying function operands (parameters). + An specifying a custom function’s return value, calculated based on the operands. + + + + When implemented by a custom function, specifies its name. + + A used to identify a custom function. + + + + When implemented by a custom function, determines its return value type based on the type of function operands (parameters). + + An array of function operator (parameter) types. + A object specifying the return value type of a custom function. + + + + Contains descriptive information about a custom function for use in the Expression editor (category, description, number of parameters). + + + + + When implemented by a custom function, designates its functional category. + + A value specifying a custom function’s category. + + + + When implemented by a custom function, returns its description. + + A text describing a custom function’s syntax and purpose. + + + + When implemented by a custom function, determines if it accepts a specified number of operands (parameters). + + An integer value specifying the number of operands (parameters) passed to a custom function. + true if the number of operands (parameters) passed as the count is valid for a custom function; otherwise, false. + + + + When implemented by a custom function, determines if a certain type can be passed as a specified operand. + + A zero-based integer value specifying an operand’s index among a custom function’s operands. + An integer value specifying the total number of operands passed to a custom function. + A object specifying an operand’s type. + true if a custom function accepts the type; otherwise, false. + + + + When implemented by a custom function, returns the maximum number of operands (parameters) this function can accept. + + An integer value specifying the maximum number of function operands (parameters) a custom function can accept. -1 indicates that a custom function accepts an infinite number of operands. + + + + When implemented by a custom function, returns the minimum number of operands (parameters) required by this function. + + An integer value specifying the least possible number of function operands (parameters) required by a custom function. 0 indicates that operands can be omitted. + + + + Implemented by custom functions that can be compiled on the client. + + + + + When implemented by a custom function, creates a LINQ expression. + + An array of Expression objects specifying function operands (parameters). + An Expression object that specifies the LINQ expression. + + + + Implemented by case-sensitive custom functions that can be compiled on the client. + + + + + When implemented by a custom function, creates a LINQ expression. + + An array of Expression objects specifying function operands (parameters). + An Expression object that specifies the LINQ expression. + + + + Implemented by custom functions that can be converted to a LINQ expression. + + + + + When implemented by a custom function, converts it to a Linq-expression. + + An DevExpress.Data.Linq.Helpers.ICriteriaToExpressionConverter object that converts a criteria to an expression. + An array of Expression objects specifying function operands (parameters). + An Expression object that specifies a LINQ expression. + + + + Implemented by custom functions that can be evaluated with case-sensitivity. + + + + + When implemented by a custom function, evaluates it on the client. + + true, if the custom function is case-sensitive; otherwise, false. + An array of objects specifying function operands (parameters). + An specifying a custom function’s return value, calculated based on the operands. + + + + Allows you to use the Query Builder or filter editor to insert a string into SQL queries generated for SELECT operations. + + + + + Returns a string for insertion into a SQL query when the custom function is evaluated (before a query is sent to the data source). + + A object that identifies the data provider. If the data source of the query expression is Microsoft SQL Server, the type is . + An array of operands (parameters) passed to a custom function. + A that substitutes a call to the custom function in a query statement. + + + + An operator which determines if a value matches any value in a specified list. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A object which represents the expression to test. + An array of objects that represent expressions to test for a match. + + + + Initializes a new instance of the class with the specified settings. + + A object which represents the expression to test. + An array of objects that represent expressions to test for a match. + + + + Initializes a new instance of the class with the specified settings. + + A value which specifies the property name. + An array of objects that represent expressions to test for a match. + + + + Initializes a new instance of the class with the specified settings. + + A value which specifies the property name. + A collection of expressions to test for a match. + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets or sets the expression which is tested to see if it matches any value in the InOperator.Operands list. + + A object which represents the expression to test. + + + + Provides access to the object that represents a collection of the operands used to construct the current . + + A object that represents a collection of the operands used to construct the current . + + + + An operator that joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the class name of persistent objects that provide data for joining. The string can contain a namespace prefix to disambiguate the class name if more than one such class name exists. This value is assigned to the JoinOperand.JoinTypeName property. + A object that represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the JoinOperand.Condition property. + An enumeration value that specifies the type of the aggregate operator. This value is assigned to the JoinOperand.AggregateType property. + A object which represents the aggregated expression. This value is assigned to the JoinOperand.AggregatedExpression property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the class name of persistent objects that provide data for joining. The string can contain a namespace prefix to disambiguate the class name if more than one such class name exists. This value is assigned to the JoinOperand.JoinTypeName property. + A object that represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the JoinOperand.Condition property. + A custom aggregate function‘s name. + A collection of aggregated expressions to assign to the JoinOperand.CustomAggregateOperands property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the class name of persistent objects that provide data for joining. The string can contain a namespace prefix to disambiguate the class name if more than one such class name exists. This value is assigned to the JoinOperand.JoinTypeName property. + A object that represents the filter criteria. null (Nothing in Visual Basic) if the filter criteria isn’t needed. This value is assigned to the JoinOperand.Condition property. + + + + For internal use. + + + + + For internal use. + + + + + Gets or sets the aggregated expression. + + A object that represents the aggregated expression. + + + + Gets or sets the type of the aggregate operator. + + An enumeration value that specifies the type of the aggregate operator. + + + + Creates a new which returns the average of values calculated by the given aggregate expression. This expression is evaluated against elements that match the specified JoinOperand.Condition. + + A object which specifies the aggregate expression. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a copy of the current instance. + + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Gets or sets the filter criteria applied to the property values of the objects being joined. + + A object that represents the filter criteria. null (Nothing in Visual Basic), if the filter criteria isn’t needed. + + + + Creates a new which returns the count of elements that match the JoinOperand.Condition. + + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a new which returns the count of elements that match the JoinOperand.Condition. + + A object which specifies the aggregate expression. This parameter may be ignored in certain circumstances. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a new custom with a custom aggregate function. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + A collection of aggregated expressions to be assigned to the JoinOperand.CustomAggregateOperands property + An object that joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Gets or sets a custom aggregate function‘s name. + + A custom aggregate function’s name. + + + + Gets an operand collection passed to a custom aggregate function. + + A collection of operand values. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Creates a new which determines whether or not the count of elements that match the JoinOperand.Condition is greater than zero. + + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a new which determines whether or not the count of elements that match the JoinOperand.Condition is greater than zero. + + A object which specifies the aggregate expression. This parameter may be ignored in certain circumstances. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets or sets the type name of persistent objects being joined with parent objects. + + A value that specifies the type name of persistent objects that provide data for joining. The value is case-sensitive. + + + + Creates a new which returns the maximum of the values calculated by the given aggregate expression. This expression is evaluated against elements that match the specified JoinOperand.Condition. + + A object which specifies the aggregate expression. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a new which returns the minimum of the values calculated by the given aggregate expression. This expression is evaluated against elements that match the specified JoinOperand.Condition. + + A object which specifies the aggregate expression. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Creates a new which returns the sum of values calculated by the given aggregate expression. This expression is evaluated against elements that match the specified JoinOperand.Condition. + + A object which specifies the aggregate expression. + An object which joins persistent objects on a specified condition, and calculates aggregate functions against matching objects. + + + + Represents a logical NOT operation which is performed on the operand. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified operand. + + A descendant which represents the operand that the logical inversion is applied to. + + + + Represents an operator which compares a persistent object’s property value with a null reference (Nothing in Visual Basic). + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified criteria operand. + + An object which represents the criteria expression. + + + + Initializes a new instance of the class with the specified property name. + + A value which specifies the name of the property to check for null (Nothing in Visual Basic). + + + + This class supports the internal infrastructure and is not intended to be used directly from your code. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + For internal use only. + + + + + An object property operand in criteria expressions. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified property name. + + A value that specifies the name of the property. It can be a path through object relationships (e.g. “Employer.DefaultAddress.City”). This value is case-sensitive. and will be assigned to the OperandProperty.PropertyName property. + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + For internal use only. + + + + + Gets or sets a property name. + + A value that specifies the name of the property. It can be a path through object relationships (e.g. “Employer.DefaultAddress.City”). This value is case-sensitive. + + + + A value operand in criteria expressions. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified value. + + The value for the operand. This value is assigned to the OperandValue.Value property. + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets or sets a value for the operand. + + The value for the operand. + + + + Gets or sets the current operand’s formatted value. + + An object that represents the current operand’s formatted value. + + + + An unary operator which performs an operation on only one expression. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified operand and operator type. + + A enumeration value which specifies the type of the unary operator. This value is assigned to the UnaryOperator.OperatorType property. + A object which represents the operand. This value is assigned to the UnaryOperator.Operand property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value which specifies the type of the unary operator. This value is assigned to the UnaryOperator.OperatorType property. + A value which specifies the property’s name. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Determines whether the current object has the same settings as the specified object. + + An object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + A object which represents the operand. + + + + + An enumeration value which specifies the type of the unary operator. + + + + + Enumerates unary operator types. + + + + + Represents the bitwise NOT operator. + To create the bitwise NOT operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“~Field1”) + + + + + Represents the operator which determines whether or not a given expression is NULL. + To create the is-null operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“Field1 IS NULL”) + + + + + Represents the unary negation (-) operator. + To create the unary negation operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“-Field1 = -10”) + + + + + Represents the logical NOT. + To create the logical NOT operator using the CriteriaOperator.Parse method use the following syntax: + CriteriaOperator.Parse(“NOT ((Field1 = A) OR (Field1 = B))”) + + + + + Represents the unary plus (+) operator. + + + + + If implemented, provides an abstraction for an object’s bindable property. + + + + + For internal use. + + + + + Provides access to the property display name. + + A value. + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + Provides access to the property name. + + A value. + + + + For internal use. + + + + + Provides access to the property type. + + A object. + + + + Provides methods that return custom names for the Field List items. + + + + + Returns the name displayed for a data source in a Field List. + + A value specifying the data source’s name. + + + + Returns the name of a table or column item displayed in a Field List. + + An array of values, corresponding to the original data member display names. + A value, specifying the new data member name. + + + + If implemented by a class, provides functionality to a report parameter. + + + + + Specifies the parameter value. + + A , specifying the parameter value. + + + + An interface that can be implemented by a data source to support master-detail relationships. + + + + + When implemented by a class, returns detail data for a relationship. + + An integer value that specifies the index of a master row in the data source. + An integer value that specifies the relationship. + An object that implements the IList interface and represents detail data for a relationship. + + + + When implemented by a class, returns the name of a master-detail relationship. + + An integer value that specifies the index of a master row in the data source. + An integer value that specifies the relationship. + The name of a master-detail relationship. + + + + When implemented by a class, returns a Boolean value that specifies whether a specific detail of a particular master row contains data. + + An integer value that specifies the index of a master row in the data source. + An integer value that specifies the relationship. + A Boolean value that specifies whether a specific detail of a particular master row contains data. + + + + When implemented by a class, returns the number of master-detail relationships for the current master data source. + + An integer value that specifies the number of master-detail relationships for the current master data source. + + + + An extended version of the interface, that can be implemented by a data source to support master-detail relationships. + + + + + When implemented by a class, returns the number of relationships for a master row. + + An integer value that specifies the master row. + An integer value that specifies the number of relationships for a master row. + + + + When implemented by a class, returns the display caption of a particular relationship in a specific master row. + + An integer value that specifies the master row. + An integer value that specifies the relationship. + A string value that specifies the display caption of a particular relationship in a specific master row. + + + + Contains classes that allow you to enable server-side data management for any LINQ provider. + + + + + The data source for the GridControl and SearchLookUpEdit that binds these controls to Entity Framework 4+ model classes in Instant Feedback Mode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the EntityInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + An Action<> delegate, which is a method that will handle the EntityInstantFeedbackSource.DismissQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the EntityInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the EntityInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + An EventHandler<> delegate, which is a method that will handle the EntityInstantFeedbackSource.DismissQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the EntityInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects that will be retrieved from a data source, at design time. + + A type of objects that will be retrieved from a data source. + + + + Occurs when the no longer needs the queryable source it used to retrieve objects from the data store. + + + + + Occurs when the needs a queryable source, to retrieve objects from the data store. + + + + + Specifies the name of the key property. + + A value that specifies the key property name. + + + + Refreshes the . + + + + + The data source for the GridControl, PivotGridControl and SearchLookUpEdit that binds these controls to Entity Framework 4+ model classes in server mode. + + + + + Initializes a new instance of the class. + + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects retrieved from a data source. + + The type of objects retrieved from a data source. + + + + Enables you to manually handle the database exception. + + + + + Enables you to manually handle the inconsistency detected during an operation on a data source. + + + + + Gets or sets the key expression. + + A value that specifies the key expression. + + + + Gets or sets the queryable data source. + + An object that implements the interface. + + + + Forces the bound data-aware control to reload data from the data store. + + + + + Provides data for the LinqInstantFeedbackSource.GetQueryable and LinqInstantFeedbackSource.DismissQueryable events. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + Gets or sets the name of the key property. + + A value indicating the key property name. + + + + Gets or sets the queryable data source. + + An object that implements the interface. + + + + Gets or sets an arbitrary object associated with a queryable source. + + An object associated with a queryable source. + + + + The data source for the GridControl and SearchLookUpEdit that binds these controls to any queryable source (‘LINQ to SQL Classes’) in Instant Feedback Mode. + + + + + Creates a new instance of the . + + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the LinqInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + An Action<> delegate, which is a method that will handle the LinqInstantFeedbackSource.DismissQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the LinqInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the LinqInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + An EventHandler<> delegate, which is a method that will handle the LinqInstantFeedbackSource.DismissQueryable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the LinqInstantFeedbackSource.GetQueryable event. The specified delegate is attached to this event. + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + Specifies how data source contents are sorted by default, when sort order is not specified by the bound control. + + A object which contains the names of the columns against which data source contents are sorted. + + + + Specifies the type of objects that will be retrieved from a data source, at design time. + + A type of objects that will be retrieved from a data source. + + + + Occurs when the no longer needs the queryable source it used to retrieve objects from the data store. + + + + + This method is intended for internal use. + + + + + Occurs when the needs a queryable source, to retrieve objects from the data store. + + + + + Specifies the name of the key property. + + A value that specifies the key property name. + + + + Refreshes the . + + + + + Provides data for the LinqServerModeSource.ExceptionThrown event. + + + + + Initialize a new instance of the class. + + The database exception. This value is assigned to the LinqServerModeExceptionThrownEventArgs.Exception property. + + + + Gets the database exception. + + The database exception. + + + + Represents a method that will handle the LinqServerModeSource.ExceptionThrown event. + + The event source. + A object that contains data related to the event. + + + + Provides data for the LinqServerModeSource.InconsistencyDetected event. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the inconsistency detected during an operation on a data source should be handled manually. + + true to manually handle the inconsistency; false to reload data from the data source. + + + + Represents a method that will handle the LinqServerModeSource.InconsistencyDetected event. + + The event sender. + A object that contains data related to the event. + + + + The data source for the GridControl and PivotGridControl that binds these controls to any queryable source (e.g., ‘LINQ to SQL Classes’ or ) in server mode. + + + + + Initializes a new instance of the class. + + + + + Specifies how data source contents are sorted by default, when sort order is not specified by the bound control. + + A object which contains the names of the columns against which data source contents are sorted. + + + + Specifies the type of objects retrieved from a data source. + + The type of objects retrieved from a data source. + + + + Enables you to manually handle the database exception. + + + + + Enables you to manually handle the inconsistency detected during an operation on a data source. + + + + + Gets or sets the key expression. + + A value that specifies the key expression. + + + + Gets or sets the queryable data source. + + An object that implements the interface. + + + + Forces the bound data-aware control to reload data from the data store. + + + + + Exposes an API that allows you to create custom masks. + + + + + Returns the action a user has performed: entered one or multiple characters (Insert), erased characters (Backspace or Delete), clicked a spin button (SpinUp, SpinDown). ActionType.Init is returned when a form is initialized, a custom mask is applied, or an editor gains or loses focus. + + Returns the type of user action. + + + + Cancels an edit a user attempts to perform. + + + + + Returns the zero-based cursor position. To obtain text blocks before and after this position, use the CurrentHead and CurrentTail properties. + + The zero-based cursor position. + + + + Returns the current editor text. This property is different from ResultEditText, which returns the editor text if user edits are accepted. + + The current editor text. + + + + Returns the current editor text that precedes the cursor position or selected text. + + The current editor text that precedes the cursor position or selected text. + + + + Returns the currently selected editor text. To obtain the zero-based position of the first and last characters of a selection, use the CurrentSelectionStart and CurrentSelectionEnd properties. + + The currently selected editor text. Returns String.Empty if no text is selected. + + + + Returns a value of either the CurrentSelectionStart (if a user selected a portion of editor text from left to right) or CurrentSelectionEnd (from right to left) property. + + The zero-based position from which a user selected a portion of the editor text. + + + + Returns the zero-based index of the right-most character of the current selection. + + The zero-based index of the right-most character of the current selection. + + + + Returns the zero-based index of the left-most character of the current selection. + + The zero-based index of the right-most character of the current selection. + + + + Returns the current editor text that follows the cursor position or selected text. + + The current editor text that follows the cursor position or selected text. + + + + Returns the text string a user attempts to add to this editor. If a user tries to erase text, this property returns String.Empty. + + The text string a user attempts to add to this editor. + + + + Returns whether an editor dicards a user action. Editors discard user actions that lead to no changes (for example, a user selects a character and types the same character, or presses Backspace when no characters behind a caret are present). + + true if a user action leads to no changes and is canceled (ignored); otherwise, false. + + + + Returns whether a portion of the current editor text is selected (the CurrentSelectedText property is not String.Empty). + + true if a portion of the current editor text is selected; otherwise, false. + + + + Returns the final position of a caret (cursor) if a user edit is accepted. The current caret position (before a user edit) is stored in the CurrentCursorPosition property. + + The final position of a caret (cursor) if a user edit is accepted. + + + + Returns the final editor text if user edits are accepted. The current editor text (before a user edit) is stored in the CurrentEditText property. + + The final editor text that includes current user edits. + + + + Returns the selection anchor if user edits are accepted. + + The final selection anchor if user edits are accepted. + + + + Sets the final editor text, selection anchor, and cursor position. + + The final editor text. + The final cursor position. + The final position of the selection anchor. + + + + Sets the final editor text and cursor position. + + The part of the editor text that precedes the caret (cursor). + The part of the editor text that follows the caret (cursor). + + + + Returns the transcript of a user edit in the following format: ‘(InitialState)->UserAction->(FinalState)’. + + The transcript of a user edit. + + + + Initializes a new instance of the class with specified settings. + + + + + Provides data for the event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Contains classes enabling server-side data management for the OData provider. + + + + + Provides data for the ODataInstantFeedbackSource.GetSource and ODataInstantFeedbackSource.DismissSource events. + + + + + This constructor is intended for internal use. + + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + This property is intended for internal use. + + + + + Gets or sets the name of the key property. + + A value indicating the key property name. + + + + Specifies the query request to the OData service. + + An IQueryable object that specifies the query request to the OData service. + + + + Gets or sets an arbitrary object associated with a queryable source. + + An object associated with a queryable source. + + + + The data source for the GridControl and SearchLookUpEdit controls that binds these controls to OData service in Instant Feedback Mode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the ODataInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + An Action<> delegate, which is a method that will handle the ODataInstantFeedbackSource.DismissSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the ODataInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the ODataInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + An EventHandler<> delegate, which is a method that will handle the ODataInstantFeedbackSource.DismissSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the ODataInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + Specifies how data source contents are sorted by default when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects that will be retrieved from a data source at design time. + + A type of objects that will be retrieved from a data source. + + + + Occurs when the no longer needs the queryable source it used to retrieve objects from the OData service. + + + + + Specifies the criteria used to filter objects on the data store side. These criteria are never affected by bound data-aware controls. + + A object specifying the filter expression applied to data on the data store side. + + + + Specifies a string representation of an expression used to filter objects on the data store side. This filter is never affected by bound data-aware controls. + + A string specifying the filter expression applied to data on the data store side. + + + + Occurs when the needs a queryable source to retrieve objects from the OData service. + + + + + Specifies the name of the key property. + + A value that specifies the key property name. + + + + For internal use. + + + + + Specifies the semicolon-separated list of property names. When the list is not emply, only the listed properties and key fields will be loaded. Otherwise, all properties are loaded. + + A string containing the semicolon-separated list of property names. + + + + Refreshes the . + + + + + The data source for the GridControl and SearchLookUpEdit controls that binds these controls to OData service in Server Mode. + + + + + Initializes a new instance of the class. + + + + + This constructor is intended for internal use. + + + + + Specifies how data source contents are sorted by default when the sort order is not specified by the bound control. + + A string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects retrieved from a data source. + + The type of objects retrieved from a data source. + + + + Occurs when the data source exception is thrown. + + + + + This property is intended for internal use. + + + + + Specifies the criteria used to filter objects on the data store side. These criteria are never affected by bound data-aware controls. + + A object specifying the filter expression applied to data on the data store side. + + + + Specifies a string representation of an expression used to filter objects on the data store side. This filter is never affected by bound data-aware controls. + + A string specifying the filter expression applied to data on the data store side. + + + + Occurs when an inconsistency has been detected during an operation on a data source. + + + + + Specifies the name of the key property. + + A value that specifies the key property name. + + + + For internal use. + + + + + Specifies the semicolon-separated list of property names. When the list is not emply, only the listed properties and key fields will be loaded. Otherwise, all properties are loaded. + + A string containing the semicolon-separated list of property names. + + + + Specifies the query request to the OData service. + + An IQueryable object that specifies the query request to the OData service. + + + + Forces the bound data-aware control to reload data from the data store. + + + + + Enables the use of the $inlinecount query option instead of the $count endpoint. + + + + + Contains classes enabling server-side data management for the Parallel LINQ to Objects provider. + + + + + Provides data for the PLinqInstantFeedbackSource.GetEnumerable and PLinqInstantFeedbackSource.DismissEnumerable events. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the enumerable data source. + + An object that implements the interface. + + + + Gets or sets an arbitrary object associated with an enumerable source. + + An object associated with an enumerable source. + + + + The data source for the GridControl and SearchLookUpEdit that binds these controls to any enumerable source in Instant Feedback Mode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.GetEnumerable event. The specified delegate is attached to this event. + An Action<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.DismissEnumerable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.GetEnumerable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.GetEnumerable event. The specified delegate is attached to this event. + An EventHandler<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.DismissEnumerable event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the PLinqInstantFeedbackSource.GetEnumerable event. The specified delegate is attached to this event. + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the maximum number of parallel threads that will be started to process a query. + + A nullable integer that specifies the maximum number of parallel threads that will be started to process a query. + + + + Specifies the type of objects that will be retrieved from a data source, at design time. + + A type of objects that will be retrieved from a data source. + + + + Occurs when the no longer needs the enumerable source it used for object retrieval. + + + + + Occurs when the needs an enumerable source, to retrieve data from it. + + + + + Refreshes the . + + + + + The data source for the , and controls that binds these controls to any enumerable source in Server Mode. + + + + + Initializes a new instance of the class. + + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the maximum number of parallel threads that will be started to process a query. + + A nullable integer that specifies the maximum number of parallel threads that will be started to process a query. + + + + Specifies the type of objects retrieved from a data source. + + The type of objects retrieved from a data source. + + + + Enables you to manually handle the data source exception. + + + + + Enables you to manually handle the inconsistency detected during an operation on a data source. + + + + + Forces the bound data-aware control to reload data from the data store. + + + + + Gets or sets the enumerable data source. + + An object that implements the interface. + + + + The component that acts as an asynchronous bridge between a data-aware control and rapidly changing data. + + + + + Initializes a new instance of the class. + + + + + Empties the changes queue, re-reads the data source and informs the bound control that the reset has occurred. + + + + + Specifies the data source from which the component retrieves its data. + + An IList or IListSource object that represents the data source from which the component retrieves its data. + + + + Specifies a semicolon-separated list of displayable property names. + + A string which is a semicolon-separated list of displayable property names. + + + + For internal use. + + + + + Returns the displayable property names of an item type contained in a specified data source. + + The data source object to examine for property information. + An IEnumerable<> list of property names. + + + + Returns the list of data source records. Introduced to support IListSource in . + + A object which is the list of data source records. + + + + Returns the delay between the data source event occurrence and passing changes to the bound control (in milliseconds). + + An integer value that is the changes queue delay in milliseconds. + + + + Specifies whether to ignore INotifyPropertyChanged.PropertyChanged events of the data source items. + + true, if the does not handle PropertyChanged events; otherwise, false. + + + + Resumes tracking changes in the data source after tracking was suspended via the RealTimeSource.Suspend method. + + + + + Specifies the timeout between the data source event occurrence and passing changes to the bound control (in milliseconds). The default timeout is 2000 ms. If the actual delay exceeds the specified timeout, the RealTimeSource.CatchUp method triggers automatically. + + + + + Suspends tracking changes in the data source. + + + + + Specifies whether or not the WeakReference is used to handle the data source’s IBindingList.ListChanged event. + + true, if the weak reference is used; otherwise, false. + + + + Provides data for an event that fires after a row is deleted. + + + + + Initializes a new instance of the class with the specified settings. + + The row handle. This value is used to initialize the RowDeletedEventArgs.RowHandle property. + The index of the row in the data source. This value is used to initialize the RowDeletedEventArgs.ListSourceIndex property. + An object that represents the current row. This value is used to initialize the RowDeletedEventArgs.Row property. + + + + Gets the index of the current row in the data source. + + The index of the current row in the data source. + + + + Gets the currently processed row. + + The currently processed row. + + + + Gets the row handle (id) that identifies the position of the current row in the control. + + An integer value that specifies the handle (id) of the current row. + + + + Provides data for an event that fires before a row is deleted. + + + + + Initializes a new instance of the class with the specified settings. + + The row handle. This value is used to initialize the RowDeletedEventArgs.RowHandle property. + The index of the row in the data source. This value is used to initialize the RowDeletedEventArgs.ListSourceIndex property. + An object that represents the current row. This value is used to initialize the RowDeletedEventArgs.Row property. + + + + Gets or sets whether the current event (the row deletion) needs to be canceled. + + true, if the current event needs to be canceled; otherwise, false. + + + + Provides data for the selection changed events. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value which specifies how the collection has been changed. This value is assigned to the SelectionChangedEventArgs.Action property. + A zero-based integer specifying the handle of the row whose selected state has been changed. This value is assigned to the SelectionChangedEventArgs.ControllerRow property. + + + + Gets an action which describes how the collection has been changed. + + A enumeration value which specifies how the collection has been changed. + + + + Identifies the row whose selected state has been changed. + + A zero-based integer identifying the row whose selected state has been changed. + + + + Represents a method that will handle the ColumnView.SelectionChanged event. + + The event sender. + A object that contains event data. + + + + Provides data for the LinqServerModeDataSource.ExceptionThrown event. + + + + + Initializes a new class instance with the specified setting. + + A object specifying the exception that caused the event. + + + + Gets the exception that caused the event. + + A object representing the exception that caused the event. + + + + Provides data for the LinqServerModeDataSource.InconsistencyDetected event. + + + + + Initializes a new class instance with default settings. + + + + + Initializes a new class instance with the specified setting. + + A object specifying the exception that caused the event. + + + + Gets the exception that caused the event. + + A object representing the exception that caused the event. + + + + Provides data for events that allow you to replace a data filter applied by an end-user. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A object that specifies the filter applied to a data control. This value is assigned to the SubstituteFilterEventArgs.Filter property. + + + + Gets or sets the filter applied to a data control. + + A object that specifies the filter applied to a data control. + + + + Lists values specifying the aggregate function types. + + + + + The average value of a column. + + + + + The record count. + + + + + Specifies whether calculations should be performed manually using a specially designed event. + + + + + The maximum value in a column. + + + + + The minimum value in a column. + + + + + Disables summary value calculation. + + + + + The sum of all values in a column. + + + + + Contains values that specify how summaries are calculated - against all rows or for the selected rows. + + + + + Calculate a summary against all rows. + + + + + Mixed mode. If a single row is selected, calculate a summary against all rows. If 2 or more rows are selected, calculate the summary against the selection. + + + + + Calculate a summary against the selection. + + + + + Contains classes that provide the TreeList control functionality common to multiple platforms. + + + + + Serves as a base for classes that represent TreeList nodes. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified content. + + An object that specifies the node’s content. This value is assigned to the TreeListNodeBase.Content property. + + + + Collapses all child nodes. + + + + + Gets or sets the node’s content. + + An object that specifies the node’s content. + + + + Expands all child nodes. + + + + + Gets whether or not the node has a child node(s). + + true if the node has a child node(s); otherwise, false. + + + + Uniquely identifies the current tree node. + + The current node’s unique identifier. + + + + Indicates whether the current node belongs to the specified branch node. + + The object. + true if the specified branch node contains the current node; otherwise, false. + + + + Gets or sets whether or not the node is expanded. + + true to expand the node; otherwise, false. + + + + Gets whether the node is filtered or not. + + true the node is filtered; otherwise, false. + + + + Gets whether the treelist node is visible. + + true, if the current node is visible; otherwise, false. + + + + Occurs every time any of the TreeListNodeBase.Content and TreeListNodeBase.IsExpanded properties have changed their value. + + + + + Gets the row handle that identifies the node. + + An integer value that specifies the row handle. + + + + Gets or sets the data associated with the node. + + An object that contains information associated with the current node. + + + + Gets the node’s position within a View among visible nodes. + + An integer value that specifies the node’s position among visible nodes. -1 if the node is hidden. + + + + Contains values that specify the data type and binding mode of columns. + + + + + Indicates that the column is unbound and it contains Boolean values (the type). + + + + + Indicates that the column is bound to a field in the control’s underlying data source. The type of data this column contains is determined by the bound field. + + + + + Indicates that the column is unbound and it contains date/time values (the type). + + + + + Indicates that the column is unbound and it contains decimal values (the type). + + + + + Indicates that the column is unbound and it contains integer values (the type). + + + + + Indicates that the column is unbound and it contains values of any type. A editor is assigned for the in-place editing of such a column. + + + + + Indicates that the column is unbound and it contains string values (the type). + + + + + A data source used to supply and obtain a typed list of objects to data-aware controls in unbound mode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An object. + + + + Adds a new row to the end of the list. + + An integer index of the new row. + + + + Changes the specified value. + + An integer row number containing the value to be changed. + A string which is the name of the property whose value should be changed. + + + + Clears the ‘s list. + + + + + Specifies the item count in the ‘s list. + + An integer which is the item count. + + + + Inserts a new row at the specified position. + + The integer index of the new row. + + + + Specifies a value within the list at a specific row index and with the specific property name. + + The zero-based index of the value. + A string which is the list property name. + An object at the specific row index and with the specific property name. + + + + Moves the row to another position. + + The integer specifying the current row index. + The integer specifying the new row index. + + + + Gets the collection of the ‘s properties. + + An object specifying the properties collection. + + + + Removes the specified row. + + The integer index of the row to be removed. + + + + Changes the capacity of the ‘s list. + + An integer specifying the new row count. + + + + Changes the row count in the ‘s list. + + An integer which is the new row count. + + + + Occurs when the ‘s list is changed. + + + + + Occurs when the ‘s list is changed. + + + + + Occurs when a value is requested from the . + + + + + Occurs when a value is set in the . + + + + + Arguments passed to the UnboundSource.UnboundSourceListChanging and UnboundSource.UnboundSourceListChanged events. + + + + + Initializes a new instance of the class. + + true, if the current event is triggered by the component API; otherwise, false. + Gets the ListChangedType enumeration value indicating the type of change. + Gets the integer index of the list row affected by the change. + Gets the PropertyDescriptor of the list property affected by the change. + + + + Initializes a new instance of the class. + + true, if the current event is triggered by the component API; otherwise, false. + Gets the ListChangedType enumeration value indicating the type of change. + Gets the integer index of the row affected by the change. + + + + Gets a value indicating if the current event is triggered by the component API. + + true, if the current event is triggered by the component API; otherwise, false. + + + + Supplies information on a column of the ‘s list. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A string that is the property name. + A object specifying the property type. + + + + Initializes a new instance of the class. + + A string that is the property name. + + + + Specifies the display name of the property. + + A string that is the property display name. + + + + Specifies the name of the property. + + A string that is the property name. + + + + Specifies the property type + + A object specifying the property type. + + + + Specifies an object that contains data associated with the property. + + An object that contains data associated with the property. + + + + A collection of the ‘s list columns. + + + + + Initializes a new instance of the class. + + An object which owns the . + + + + Adds the specified item to the collection. + + An item to be added to the current . + + + + Adds the specified items to the collection. + + An list of items to be added to the current . + + + + Adds the specified items to the collection. + + An IEnumerable<> list of items to be added to the current . + + + + Clears the collection and adds the specified items to it. + + An IEnumerable<> list of items to be added to the current . + + + + Specifies an item within the collection at a specific index. + + The zero-based index of the item. + An item at a specific index. + + + + Specifies an item within the collection with a specific name. + + A string which is the UnboundSourceProperty.Name of the item. + An item with the specific name. + + + + Arguments, passed to the UnboundSource.ValueNeeded event. + + + + + Gets the name of the property whose value is requested. + + A string which is the property name. + + + + Gets the row index of the value. + + The integer index of the row. + + + + Gets an object that contains data associated with the value. + + An object that contains data associated with the value. + + + + Specifies the value which is requested. + + An object specifying the value which is requested. + + + + Arguments, passed to the UnboundSource.ValuePushed event. + + + + + Gets the name of the property whose value is being set. + + A string that is the property name. + + + + Gets the row index of the value. + + An integer index of the row. + + + + Gets an object that contains data associated with the value. + + An object that contains data associated with the value. + + + + Specifies the value which is being set. + + An object specifying the value which is being set. + + + + Contains utility classes and interfaces for DevExpress components. + + + + + Allows you to change the path specified in the connection string as required to access the data source file. + + + + + Translates a path specified in the connection string to an actual data source file path. + + A value, specifying a path to translate. + A value that is the actual file path. + + + + Contains classes that provide client-side functionality for DevExpress components. + + + + + Provides data for the corresponding events. + + + + + Initializes a new instance of the class with the specified settings. + + A value. This value is assigned to the ScalarOperationCompletedEventArgs<T>.Result property. + A value. + true if the operation has been cancelled; otherwise false. + A value. + + + + Returns the scalar operation result. + + A generic value. + + + + Contains information on the sorting, filtering and summary configurations applied in the bound grid control. + + + + + Initializes a new instance of the class with the specified settings. + + An object to initialize the VirtualServerModeConfigurationInfo.Filter property. + An object to initialize the VirtualServerModeConfigurationInfo.SortInfo property. + An object to initialize the VirtualServerModeConfigurationInfo.TotalSummary property. + + + + Gets the grid’s current filter criteria. + + The filter criteria applied to the grid. + + + + Gets the grid’s current column sorting configuration. + + The column sorting configuration applied to the grid. + + + + Gets the total summaries the grid asks the data source to calculate. + + The total summaries the grid asks the data source to calculate. + + + + Provides data for the VirtualServerModeSource.GetUniqueValues event. + + + + + Initializes a new instance of the class with the specified settings. + + An object to initialize the VirtualServerModeGetUniqueValuesEventArgs.CancellationToken property. + An object to initialize the VirtualServerModeGetUniqueValuesEventArgs.ValuesExpression property. + An object to initialize the VirtualServerModeGetUniqueValuesEventArgs.FilterExpression property. + An object to initialize the VirtualServerModeGetUniqueValuesEventArgs.MaxCount property. + + + + Gets a token that allows you to respond to a task cancellation request invoked by the grid control. + + A cancellation token. + + + + Gets the filter expression applied to the grid. + + The filter expression applied to the grid + + + + Gets the maximum number of filter values to return. + + The maximum number of filter values to return + + + + Gets or sets the task that returns requested values. + + A Task that returns requested values. + + + + Gets or sets the expression that identifies the currently processed column. This can be a field name or an expression (for calculated columns). + + The expression that identifies the currently processed column. + + + + Gets the currently processed column name (field name), provided that this name can be unambiguously identified. + + The currently processed column name. + + + + Provides data for the VirtualServerModeSource.MoreRows and VirtualServerModeSource.ConfigurationChanged events. + + + + + Initializes a new instance of the class with the specified settings. + + An object to initialize the VirtualServerModeRowsEventArgs.CancellationToken object. + An object to initialize the VirtualServerModeRowsEventArgs.ConfigurationInfo object. + An object to initialize the VirtualServerModeRowsEventArgs.CurrentRowCount object. + An object to initialize the VirtualServerModeRowsEventArgs.UserData object. + + + + Gets a token that allows you to respond to a task cancellation request invoked by the grid control. + + A cancellation token. + + + + Gets information on the grid’s current sorting, filtering and summary configuration. + + An object that provides the grid’s sorting, filtering and summary configuration. + + + + Gets the count of rows currently loaded to the grid. + + The number of loaded rows. + + + + Gets or sets the task that returns requested rows. + + A Task that returns requested rows. + + + + Read this parameter to get custom data passed from the previously called Task or ConfigurationChanged event handler. + When handling the VirtualServerModeSource.ConfigurationChanged event, set the UserData event parameter to pass custom data to a subsequent VirtualServerModeSource.MoreRows event handler (unless you specify the RowsTask event parameter). + + Any custom data. + + + + The type of the result for Tasks created in your VirtualServerModeSource.MoreRows and VirtualServerModeSource.ConfigurationChanged event handlers. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + The object to initialize the VirtualServerModeRowsTaskResult.Rows property. + The object to initialize the VirtualServerModeRowsTaskResult.MoreRowsAvailable property. + The object to initialize the VirtualServerModeRowsTaskResult.UserData property. + + + + Gets or sets whether additional rows are available. + + true, if more rows are available; otherwise, false. + + + + Gets or sets the row collection for the current batch. + + The collection of rows to retrieve. + + + + Gets or sets custom data to pass to your VirtualServerModeSource.MoreRows event handler the next time this event is called. + + Custom data. + + + + A data source that features event-based data operations: async data load, sorting, filtering and infinite scrolling through records (in a bound Windows Forms ). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified owner container. + + The owner container of the created instance. + + + + Initializes a new instance of the class with the specified row type. + + A value to initialize the VirtualServerModeSource.RowType property. + + + + This event can be handled to provide an inner list that will be storage for rows fetched using the VirtualServerModeSource’s events. + To enable CRUD operations in a bound Data Grid, you need to provide an inner list that supports these operations. If no inner list is supplied (or you do not handle the AcquireInnerList event), CRUD operations are disabled in the grid control. + + + + + Allows you to specify whether the requested filtering, sorting or summary calculation operation needs to be accepted or canceled. + + + + + Fires on initial data load and reload in the bound grid control, and when the data grid’s sort and filter configuration changes. + Allows you to initialize the data source and (optionally) return an initial batch of records. + + + + + Allows you to provide values for columns’ filter dropdowns. + + + + + Fires when a bound grid control asks the data source for a new batch of rows. + + + + + Reloads data from your source by firing the dedicated events (VirtualServerModeSource.ConfigurationChanged and VirtualServerModeSource.MoreRows). + + + + + Gets or sets the type of object whose public properties identify data-aware control columns. + + The row object’s type. + + + + Fires when a grid control asks the data source to calculate total summaries. + + + + + Provides data for the VirtualServerModeSource.TotalSummary event. + + + + + Gets a token that allows you to respond to a task cancellation request invoked by the grid control. + + A cancellation token. + + + + Gets information on the grid’s current sorting, filtering and summary configuration. + + An object that provides the grid’s sorting, filtering and summary configuration. + + + + Allows you to update the bound grid control with intermediate summary values. + + A dictionary that contains intermediate summary values. + + + + This member supports the internal infrastructure. + + + + + Gets or sets the task that returns the requested summary value. + + A Task that returns a summary value. + + + + Contains classes enabling server-side data management for the WCF Data Services provider. + + + + + Provides data for the WcfInstantFeedbackSource.GetSource and WcfInstantFeedbackSource.DismissSource events. + + + + + This constructor is intended for internal use. + + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + This property is intended for internal use. + + + + + Gets or sets the name of the key property. + + A value indicating the key property name. + + + + Specifies the query request to the WCF data service. + + An IQueryable object that specifies the query request to the WCF data service. + + + + Gets or sets an arbitrary object associated with a queryable source. + + An object associated with a queryable source. + + + + The data source for the GridControl and SearchLookUpEdit controls that binds these controls to a WCF Data Service in Instant Feedback Mode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the WcfInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + An Action<> delegate, which is a method that will handle the WcfInstantFeedbackSource.DismissSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An Action<> delegate, which is a method that will handle the WcfInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the WcfInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + An EventHandler<> delegate, which is a method that will handle the WcfInstantFeedbackSource.DismissSource event. The specified delegate is attached to this event. + + + + Initializes a new instance of the with the specified settings. + + An EventHandler<> delegate, which is a method that will handle the WcfInstantFeedbackSource.GetSource event. The specified delegate is attached to this event. + + + + Specifies whether elements retrieved by the ‘s queryable source are thread-safe. + + true, if elements retrieved by the queryable source are thread-safe; otherwise, false. + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects that will be retrieved from a data source, at design time. + + A type of objects that will be retrieved from a data source. + + + + Occurs when the no longer needs the queryable source it used to retrieve objects from the WCF data service. + + + + + Specifies the criteria used to filter objects on the data store side. These criteria are never affected by bound data-aware controls. + + A object specifying the filter expression applied to data on the data store side. + + + + Specifies a string representation of an expression used to filter objects on the data store side. This filter is never affected by bound data-aware controls. + + A string specifying the filter expression applied to data on the data store side. + + + + Occurs when the needs a queryable source, to retrieve objects from the WCF data service. + + + + + Specifies the name of the key property. + + A value that specifies the key property name. + + + + Refreshes the . + + + + + The data source for the GridControl and SearchLookUpEdit controls that binds these controls to a WCF Data Service in Server Mode. + + + + + Initializes a new instance of the class. + + + + + This constructor is intended for internal use. + + + + + Specifies how data source contents are sorted by default, when the sort order is not specified by the bound control. + + The string which contains the column name(s) against which data source contents are sorted and the sort order(s). + + + + Specifies the type of objects retrieved from a data source. + + The type of objects retrieved from a data source. + + + + Occurs when a data source exception is thrown. + + + + + This property is intended for internal use. + + + + + Specifies the criteria used to filter objects on the data store side. These criteria are never affected by bound data-aware controls. + + A object specifying the filter expression applied to data on the data store side. + + + + Specifies a string representation of an expression used to filter objects on the data store side. This filter is never affected by bound data-aware controls. + + A string specifying the filter expression applied to data on the data store side. + + + + Occurs when an inconsistency has been detected during an operation on a data source. + + + + + Specifies the key expression. + + A string that specifies the key expression. + + + + Specifies the query request to the WCF data service. + + An IQueryable object that specifies the query request to the WCF data service. + + + + Forces the bound data-aware control to reload data from the data store. + + + + + Provides basic functionality to the Report Wizard pages in WinForms and WPF applications. + + + + + If implemented, provides the Model functionality to a Data Source Wizard. + + + + + If implemented, represents a page of the Report Wizard. + + + + + If implemented, initializes controls of a Report Wizard page. + + + + + Occurs when settings on the current wizard page were changed. + + + + + Saves settings specified by a wizard page to the report model. + + + + + Fires when an error occurs for the current report page. + + + + + Specifies whether or not the Finish button is enabled on a wizard page. + + true, if the Finish button is enabled; otherwise, false. + + + + If implemented, returns the type of the next wizard page. + + A enumeration value. + + + + If implemented, provides access to the wizard model, which accumulates settings specified by an end-user during wizard execution. + + A TModel object containing settings specified by an end-user during wizard execution. + + + + Specifies whether or not the Next button is enabled on a wizard page. + + true, if the Next button is enabled; otherwise, false. + + + + If implemented, provides access to the content of a wizard page. + + A value. + + + + If implemented, validates the correctness of settings specified on a wizard page. + + A value specifying the text of an error message shown if the validation fails. + true, if the validation succeeded; otherwise, false. + + + + A factory that creates Data Source wizard pages. + + + + + Returns a wizard page of the specified type. + + A enumeration value. + An object implementing the interface. + + + + If implemented, provides the View functionality to the Data Source Wizard. + + + + + Occurs after clicking the Cancel button in a wizard. + + + + + Specifies whether or not the Finish button is available in a wizard. + + true, if the Finish button is available; otherwise, false. + + + + Specifies whether or not the Next button is available in a wizard. + + true, if the Next button is available; otherwise, false. + + + + Specifies whether or not the Previous button is available in a wizard. + + true, if the Previous button is available; otherwise, false. + + + + Occurs after clicking the Finish button in a wizard. + + + + + Occurs after clicking the Next button in a wizard. + + + + + Occurs after clicking the Previous button in a wizard. + + + + + Specifies the content of a wizard page. + + A value. + + + + Displays an error message with a specified text. + + A value. + + + + A Data Source Wizard instance associated with a specific View. + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the interface. + An object implementing the interface. + An object implementing the interface. + + + + Occurs when a wizard execution has been cancelled. + + + + + Occurs when a wizard execution has been completed. + + + + + Returns the current wizard page. + + An object implementing the interface. + + + + Returns the resulting wizard model. + + An object implementing the interface. + + + + Occurs when a wizard has been navigated to the next page. + + + + + Specifies the starting wizard page. + + A enumeration value. + + + + Provides access to an object that provides the view functionality to a Data Source Wizard. + + An object implementing the interface. + + + + The base for classes providing functionality to Data Source Wizard pages. + + + + + Initializes controls of the current wizard page. + + + + + Occurs when settings on the current wizard page were changed. + + + + + Saves settings specified by a wizard page to the report model. + + + + + Fires when an error occurs for the current report page. + + + + + Specifies whether or not the Finish button is enabled on a wizard page. + + true, if the Finish button is enabled; otherwise, false. + + + + Returns the type of the next wizard page. + + A enumeration value. + + + + Provides access to the wizard model, which accumulates settings specified by an end-user during wizard execution. + + A TModel object containing settings specified by an end-user during wizard execution. + + + + Specifies whether of not the Next button is enabled on a wizard page. + + true, if the Next button is enabled; otherwise, false. + + + + Provides access to the content of a wizard page. + + A value. + + + + Validates the correctness of settings specified on a wizard page. + + A value specifying the text of an error message shown if the validation fails. + true, if the validation succeeded; otherwise, false. + + + + Provides data for the IWizardPage<TWizardModel>.Error event. + + + + + Initializes a new instance of the class with the specified error message. + + A value, specifying the error message. + + + + Specifies the text of an error message. + + A value, specifying the error message. + + + + Contains classes that define the data connectivity for a WPF Report Wizard. + + + + + Contains data related to columns available in a datasource. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + For internal use. Specifies the type of data column to draw an appropriate icon in the WPF Report Designer’s Field List. + + A enumeration value. + + + + Lists the available data member types. + + + + + The data member is a query. + + + + + The data member is a stored procedure. + + + + + The data member is a table. + + + + + The data member is a view. + + + + + Contains information about a data source. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + For internal use. Specifies whether a datasource is table-based (e.g., a database), or object-model-based (e.g., an XPO object). + + true if the datasource is table-based; otherwise false. + + + + The base class for the , and objects that are stored in a Report Wizard’s model. + + + + + Specifies the data source display name for a WPF Report Wizard. + + A value, specifying the data source display name. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + Specifies the data source name. + + A TName object that is the name of the entity. + + + + Provides information about a stored procedure. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + A value specifying the stored procedure name. + A value specifying the stored procedure display name. + A collection of stored procedure parameters. + + + + Creates a copy of the current . + + An object that represents a newly created copy of the current . + + + + When connecting to a data source using the WPF Report Wizard, assigns identifiers to data tables, views and stored procedures, as well as their data members. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Classifies the data member that belongs to a connected data source. + + A enumeration value, classifying the data member. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Contains classes that utilize the most popular approaches to access different data providers. + + + + + When implemented by a class, provides basic functionality required by data access components. + + + + + Gets the name of a data member associated with the current data component. + + A containing the name of a data member. + + + + Retrieves the data from a data source. + + A collection of values. + + + + Loads the data source schema definition from XML. + + A value containing an XML definition of the data source schema. + + + + Specifies the name of the current data component. + + A containing the data component name. + + + + Saves the XML definition of the data source schema. + + A value containing an XML definition of the data source schema. + + + + Contains classes that are required to customize a data source connection wizard. + + + + + Lists the values indicating the handled exceptions. + + + + + An exception is related to a data connection. + + + + + A default exception handler. + + + + + An exception occurred while loading a wizard. + + + + + Provides functionality to run the Data Source Wizard. + + + + + Displays a confirmation window before the execution of a wizard. + + A value. + true, if a user clicks OK; otherwise, false. + + + + Creates a Data Source Wizard view. + + A value. + A structure. + An object implementing the interface. + + + + Runs the wizard with a specified model. + + A object. + true, to save the changes to the wizard model; otherwise, false. + + + + Displays a message with the specified text and caption before the execution of a wizard. + + A value. + A value. + + + + Displays a message with the specified text before the execution of a wizard. + + A value. + + + + Returns an object that displays a form while the wizard is loading information about a data source. + + An object implementing the interface. + + + + Provides a service functionality to the Data Connection wizard. + + + + + When implemented by a class, provides the exception handler functionality. + + + + + Indicates whether there are exceptions to handle. + + true, if there are exceptions to handle; otherwise, false. + + + + Handles the specified exception. + + A object. + + + + If implemented, enables the Cancel button on a form. + + + + + Closes the associated form window. + + + + + If implemented, provides the splash screen functionality. + + + + + Closes the splash screen. + + + + + Closes the splash screen, applying the specified settings. + + true to throw an exception after closing the form window; otherwise false. + An integer value, specifying the timeout before closing the form window. + true to wait until a user closes the window; false to automatically close the window after exceeding the specified timeout. + + + + Specifies whether or not the Cancel button is available on a splash screen. + + true if the Cancel button is available; otherwise false. + + + + Specifies whether or not to display a splash screen description. + + true to display the description; otherwise false. + + + + Specifies the caption of a splash screen. + + A value, specifying the form caption. + + + + Specifies the text of a splash screen description. + + A value, specifying the form description. + + + + Specifies the content of a splash screen. + + An object implementing the interface. + + + + Displays a splash screen with the specified parameters. + + true to use the fade-in animation when loading the form. + true to use the fade-out animation when closing the form. + true to enable the timeout when loading the form. + + + + Contains classes that provide functionality required for connecting to Entity Framework data sources. + + + + + Enumerates values that specify the container type. + + + + + Specifies the Entity Framework data model. + + + + + Specifies the WCF data service. + + + + + If implemented, provides information about a project type containing an Entity Framework data model. + + + + + Specifies the container type. + + A enumeration value. + + + + Contains classes that provide information about the known types in the current solution that are required to connect to Entity Framework data sources. + + + + + When implemented by a class, provides information about its containing assembly. + + + + + Indicates the full name of the current assembly. + + A value, specifying the assembly name. + + + + Indicates whether the current assembly is an assembly of the current project. + + true, if the current assembly is an assembly of the current project; otherwise, false + + + + Indicates whether the current assembly is an assembly of the current solution. + + true, if the current assembly is an assembly of the current solution; otherwise, false. + + + + Obtains resource options for the current assembly. + + An object. + + + + Obtains a collection of types available in the current assembly. + + A collection of objects. + + + + When implemented by a class, provides information about a project type. + + + + + Obtains the assembly in which the current type is defined. + + An object containg information about the assembly in which the current type is defined. + + + + Obtains the fully qualified name of the current type, including the namespace. + + A value. + + + + Indicates whether a type is defined within the current solution. + + true, if a type is defined in the current solution; otherwise, false. + + + + Obtains the name of the namespace containing the current type + + A value. + + + + Returns the current type. + + A object. + + + + When implemented by a class, provides information about known project types. + + + + + Obtains a collection of assemblies available for the current project. + + A collection of objects. + + + + Obtains the existing object that provides information about a known project type, or creates a new one if it was not found. + + A object. + An object containing information about a project type. + + + + Obtains project types that satisfy the specified filtering condition. + + A System.Func delegate specifying a filtering condition. + A collection of objects. + + + + Obtains assemblies containing project types that satisfy the specified filtering condition. + + A System.Func delegate specifying a filtering condition. + A collection of objects. + + + + Obtains the assembly of the current project. + + An containing information about the assembly of the current project. + + + + Obtains the name of the current assembly + + A string containing the assembly name. + + + + When implemented by a class, provides options for project resources. + + + + + If implemented, provides access to the known types in the current solution. + + + + + Provides access to types available for the current project. + + An object, providing access to project types. + + + + Adds a new reference by an assembly name. + + A specifying the name of an assembly to reference. + + + + Adds a new reference by an assembly file path. + + A specifying the path to an assembly file. + + + + Returns the first found type that satisfies the specified predicate. + + A System.Predicate delegate. + An object. + + + + Obtains a project type by its full name. + + A value specifying the full name of a type. + An object. + + + + Obtains a collection of types that extend the specified base class and satisfy the specified predicate. + + An object. + A System.Predicate delegate. + A collection of objects. + + + + Obtains a collection of types that satisfy the specified predicate. + + A System.Predicate delegate. + A collection of objects. + + + + Obtains the specified assembly + + A specifying the name of the assembly to obtain. + An object containing information about an assembly. + + + + Returns the path to an application’s assembly reference. + + A value, specifying the project assembly. + A value, specifying the reference name. + A value. + + + + Obtains project types available in the specified assembly. + + A specifying the name of an assembly. + An object providing access to project types. + + + + Obtains a collection of available types. + + A collection of objects. + + + + Indicates whether the specified assembly is referenced by the project. + + A specifying the assembly name. + true, if an assembly is referenced by the project; otherwise, false. + + + + Contains settings controlling data export from controls. + + + + + Contains values that specify whether or not the Clipboard Management feature is enabled. + + + + + Equal to the ClipboardMode.PlainText value. + + + + + Data is copied to the Clipboard together with its format settings. + + + + + Copied data is stored in Clipboard as simple plain text. + + + + + Provides base properties that manage copy/paste operations from/to Data Grid and Tree List controls. + + + + + Initializes a new instance of the class with the specified settings. + + true, if the ClipboardOptions.ClipboardMode property should be set to Formatted; otherwise, false. + + + + Gets or sets whether copying data in CSV format is enabled. + + A value that specifies whether copying data in CSV format is enabled. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether copying data in XLS (Biff8) format is enabled. + + A value that specifies whether copying data in XLS (Biff8) format is enabled. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether copying data in HTML format is enabled. + + A value that specifies whether copying data in HTML format is enabled. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether copying data in RTF format is enabled. + + A value that specifies whether copying data in RTF format is enabled. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether copying data in Text and UnicodeText formats is enabled. + + A value that specifies whether copying data in Text and UnicodeText formats is enabled. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether data is copied to the Clipboard as plain text or along with its format settings (in RTF, HTML, XLS (Biff8), CSV, UnicodeText and Text formats). + + A ClipboardMode enumerator value that specifies whether or not data copied from the target control should be stored together with its format settings. + + + + Gets or sets whether formatted data is copied from both expanded and collapsed rows/nodes. + + A value that specifies if an end-user can copy formatted data from both expanded and collapsed selected rows/nodes. The Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether column and band headers are to be copied along with data cells. + + A value that specifies if the column and band headers are copied. The Default value is equal to DefaultBoolean.True. + + + + Gets or sets data pasting mode. + + Data pasting mode. + + + + Gets or sets whether a progress bar that indicates a data copy operation’s progress is enabled. + + A value that specifies if the progress bar is visible when copying very large amounts of RTF or HTML formatted data. + + + + Contains values that specify how data is pasted to a target grid/treelist control. + + + + + Pasted data is added as new rows to the target control. + + For the WinForms Tree List control, use the TreeListOptionsClipboard.PasteAsChildNodes setting to specify if pasted data is inserted as the focused node’s children or siblings. + + + + + Data Grids: The Default mode is equivalent to None (data pasting is not allowed) for controls not in master-detail mode, and for master Views in master-detail mode. For detail Views in master-detail mode, the actual paste mode is determined by master Views. + Tree Lists: The Default mode is equivalent to None (data pasting is not allowed). + + + + + Data pasting is disabled. + + + + + Pasted data updates existing cells of the target control. + + + + + Contains values that specify the visibility of the progress bar. + + + + + The progress bar is always visible when copying data. + + + + + The progress bar is visible only when copying large portions of RTF- or HTML-formatted data. + + + + + The progress bar is never shown. + + + + + Identifies data pasting modes. + + + + + The same value as OnlyValidRow. + + + + + Forces the control to paste a row, even if the row contains invalid data. + + + + + Only valid rows are pasted. Invalid rows are skipped. + + + + + Contains classes used to encrypt spreadsheet documents. + + + + + Contains encryption options for a workbook. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Stores the default EncryptionOptions.Type value that is ModelEncryptionType.Strong. + + + + + Gets or sets the password to encrypt the workbook. + + A string that is the password to protect the document. + + + + For internal use. + + + + + Resets all encryption options to their default values. + + + + + Gets or sets the encryption mechanism used to create a password-protected workbook. + + An enumeration member that specifies the encryption type. The default is ModelEncryptionType.Strong. + + + + Lists supported encryption types for a workbook. + + + + + Standard encryption for XLSX files that uses a binary EncryptionInfo structure. The default encryption algorithm is AES-128 and SHA-1 is used as a hashing algorithm. XLS files are encrypted by 40-bit RC4 encryption. + Supported in Microsoft Excel 2007 and higher. + + + + + Agile encryption for XLSX files that uses an XML EncryptionInfo structure. The default encryption algorithm is AES-256 and SHA512 is used as a hashing algorithm. XLS files are encrypted by 40-bit RC4 encryption. + Supported in Microsoft Excel 2010 and higher. + + + + + Contains classes that implement basic functionality for creating schedules. + + + + + Lists the day types regarding the recognized working activity. + + + + + This date is treated as a holiday. + + + + + This date cannot be attributed to a working day or holiday. + + + + + This date is treated as a working day. + + + + + Represents a day that is recognized as a work day. + + + + + Initializes a new instance of the class with the specified date and display name. + + A value that specifies the date of the working day. This value is assigned to the KnownDateDay.Date property. + A which specifies the display name of the working day. This value is assigned to the KnownDateDay.DisplayName property. + + + + Determines whether the specified date is treated as a working day for the current . + + A value representing the date to check. + A DateCheckResult.WorkDay enumeration value if the date is a work day; otherwise the DateCheckResult.Unknown value. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Determines whether the specified date is treated as a working day. + + A value representing the date to be identified. + true if the specified day is a working day; otherwise, false. + + + + Gets the day type associated with this class. + + An WorkDayType.ExactWorkDay enumeration value. + + + + Represents a day that is recognized as a holiday. + + + + + Initializes a new instance of the class with the specified date, display name and location. + + A value that specifies the date of the holiday. This value is assigned to the KnownDateDay.Date property. + A which specifies the display name of the holiday. This value is assigned to the KnownDateDay.DisplayName property. + A which specifies the location of the holiday. This value is assigned to the Holiday.Location property. + + + + Initializes a new instance of the class with the specified date and display name. + + A value that specifies the date of the holiday. This value is assigned to the KnownDateDay.Date property. + A which specifies the display name of the holiday. This value is assigned to the KnownDateDay.DisplayName property. + + + + Determines whether the specified date is treated as a working day for the current holiday. + + A value representing the date to check. + A DateCheckResult.Holiday enumeration value if the date is a holiday; otherwise the DateCheckResult.Unknown value. + + + + Creates a copy of the current object. + + A object which is a copy of the current object. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Determines whether the specified date is treated as a working day for the current holiday. + + A value representing the date to be identified. + Always false. + + + + Gets or sets the location attribute of the holiday. + + A value that specifies the holiday’s location. + + + + Gets the day type associated with this class. + + A WorkDayType.Holiday enumeration value. + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Serves as a base class to represent a day corresponding to the particular date. + + + + + Returns a date, associated with the current KnownDateDay object or its descendant. + + A value. + + + + Gets or sets the name of the day to display, associated with the current KnownDateDay object or its descendant. + + A representing a name of the day. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Represents a class implemented to load holidays from the Outlook.hol file. + + + + + Initializes a new instance of the class with the default settings. + + + + + Retrieves locations for which holidays are present. + + A containing holidays, as they are specified for MS Outlook. + An array of strings containing location names. + + + + Retrieves locations for which holidays are present. + + A string representing the location of the file containing holidays in MS Outlook format. + An array of strings containing location names. + + + + Loads holidays for specified locations from the specified file. + + A string that is the location of the holidays file. For MS Office 2013 US English you can find it at C:\Program Files\Microsoft Office\Office15\1033\outlook.hol. + An array of strings containing location names. + A collection containing holidays imported from MS Outlook. + + + + Loads holidays for specified locations from the specified file, using the specified encoding. + + A string that is the location of the holidays file. For MS Office 2013 US English you can find it at C:\Program Files\Microsoft Office\Office15\1033\outlook.hol. + A class representing a character encoding. + An array of strings containing location names. + A collection containing holidays imported from MS Outlook. + + + + Loads holidays from the specified file. + + A string that is the location of the holidays file. For MS Office 2013 US English you can find it at C:\Program Files\Microsoft Office\Office15\1033\outlook.hol. + A collection containing holidays imported from MS Outlook. + + + + Loads holidays for specified locations from the specified stream. + + A containing holidays as they are represented for MS Outlook. + An array of strings containing location names. + A collection containing holidays imported from MS Outlook. + + + + Loads holidays for specified locations from the specified stream, using the specified encoding. + + A containing holidays as they are represented for MS Outlook. + A class representing a character encoding. + An array of strings containing location names. + A collection containing holidays imported from MS Outlook. + + + + Loads holidays from the specified stream. + + A containing holidays as they are represented for MS Outlook. + A collection containing holidays imported from MS Outlook. + + + + Serves as a base class for classes that represent a day, regarding the working activity recognized for the specific date. + + + + + Determines how to treat the specified date in terms of the work day and a holiday. + + A value, representing the date to check. + A enumeration member. + + + + Determines whether the specified date is treated as a working day for the current working day. + + A value representing the date to be identified. + true if the specified date is a working day; otherwise, false. + + + + Gets the type of the day that the current instance of the WorkDay class descendant represents. + + A enumeration member specifying the day type. + + + + Lists day types by the working activity. + + + + + Indicates that a particular, exact date is a work day. + + + + + Indicates that this day is a holiday. + + + + + Indicates a weekday. + + + + + Contains classes that allow you to specify security access settings. + + + + + Specifies access permissions. + + + + + Allows access. + + + + + Denies access. + + + + + Allows you to restrict external resource locations for security reasons. + + + + + Initializes a new instance of the class. + + + + + For internal use. + + + + + + + + Provides access to the class’s instance that allows you to specify data resource access settings. + + The object that allows you to set access rules to data resources. + + + + Provides access to the class’s instance that allows you to specify Reporting-specific resource access settings. + + The object that allows you to set Reporting-specific resource access rules. + + + + Sets resource access rules. Raises an exception if this method is called for the second time while the application is running. + + An array of access rules. + + + + Provides access to the class’s instance that allows you to specify static resource access settings. + + The object that allows you to set static resource access rules. + + + + Sets resource access rules. + + An array of access rules. + true, if the specified rule collection is registered successfully. Otherwise, false. + + + + A rule that uses a custom logic to determine whether to allow or deny access to a URL/file directory. + + + + + Creates an instance of the CustomAccessRule class. + + The enumeration value that specifies whether the created rule allows or denies access. + + + + Occurs when URI accessibility is checked. + + + + + A rule that allows or denies access to a file directory. + + + + + Creates the type rule that provides the specified access permission to the specified file directories. + + The enumeration value that specifies whether the created rule allows or denies access to the specified file directories. + An array of file directories that the created rule allows or denies. + + + + Creates an instance of the that provides the specified access permission to file directories. + + The enumeration value that specifies whether the created rule allows or denies access to file directories. + + + + Creates the that allows resource loading only from the file directories passed as the parameter. + + An array of file directories that this rule allows. Other directories are considered as denied in this application. + An instance of the class. + + + + Creates the that denies resource load from the file directories passed as the parameter. + + An array of file directories that this rule denies. Other directories are considered as allowed in this application. + An instance of the class. + + + + A rule that allows or denies access. + + + + + Indicates whether the rule allows or denies access. + + The enumeration value. + + + + A rule that allows or denies access to a URI. + + + + + Determines whether the rule allows resource load from the specified URI. + + The URI whose accessibility this method checks. + true, if the application can load resources from the specified URI. Otherwise, false. + + + + A base class for the and classes. + + + + + A rule that allows or denies access to a URL. + + + + + Creates the that provides the specified access permission to specified URLs. + + The enumeration value that specifies whether the created rule allows or denies access to the specified URls. + An array of Urls that the created rule allows or denies. + + + + Creates an instance of the that provides the specified access permission to URLs. + + The enumeration value that specifies whether the created rule allows or denies access to URls. + + + + Creates the rule that allows resource loading only from the URLs passed as the parameter. + + An array of URLs that this rule allows. Other URLs are considered as denied in this application. + An instance of the class. + + + + Creates the that denies resource loading from the URLs passed as the parameter. + + An array of URLs that this rule denies. Other URLs are considered as allowed in this application. + An instance of the class. + + + + Contains classes representing a set of services intended to facilitate the implementation of common tasks, such as keyboard and mouse event handling. + + + + + Defines a service used to process keyboard input. + + + + + Override this method in a descending class to handle the KeyDown event. + + This class is equivalent to System.Windows.Forms.KeyEventArgs and contains information about the pressed key and key modifiers. + + + + Override this method in a descending class to handle the KeyPress event. + + This class is equivalent to System.Windows.Forms.KeyPressEventArgs and specifies the ASCII character that corresponds to the key a user pressed. + + + + Override this method in a descending class to handle the KeyUp event. + + This class is equivalent to System.Windows.Forms.KeyEventArgs and contains information about the released key and key modifiers. + + + + Defines a service used to handle mouse events. + + + + + Override this method in a descending class to handle the MouseDown event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on the pressed mouse button, the mouse coordinates, and the mouse wheel rotations. + + + + Override this method in a descending class to handle the MouseMove event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the mouse coordinates, and the amount the mouse wheel moved. + + + + Override this method in a descending class to handle the MouseUp event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the number of times the mouse button was pressed and released, the mouse coordinates, and the amount the mouse wheel moved. + + + + Override this method in a descending class to handle the MouseWheel event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the mouse coordinates, and the amount the mouse wheel moved. + + + + Allows you to display a progress indicator for time-consuming operations. + + + + + Initializes and displays a progress indicator. + + A string indicating what action is currently performed + An integer specifying the minimum indicator value. + An integer specifying the maximum indicator value. + An integer specifying the current indicator value. + + + + Finalizes progress indication. + + + + + Modifies the indicator value to track progress. + + An integer that is the value indicating the current progress. + + + + A base class for custom services used to process keyboard input. + + + + + Initializes a new instance of the class with the specified service. + + An object exposing the interface. + + + + Override this method to handle the KeyDown event. + + This class is equivalent to System.Windows.Forms.KeyEventArgs and contains information about the pressed key and key modifiers. + + + + Override this method to handle the KeyPress event. + + This class is equivalent to System.Windows.Forms.KeyPressEventArgs and specifies the ASCII character corresponding to the key a user pressed. + + + + Override this method to handle the KeyUp event. + + This class is equivalent to System.Windows.Forms.KeyEventArgs and contains information about the released key and key modifiers. + + + + Provides access to the service interface of the wrapper. + + An interface of the wrapper. + + + + A base class for custom services used to process mouse events. + + + + + Initializes a new instance of the class with the specified service. + + An object exposing the interface. + + + + Override this method to handle the MouseDown event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the mouse coordinates, and the amount the mouse wheel moved. + + + + Override this method to handle the MouseMove event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the mouse coordinates, and the amount the mouse wheel moved. + + + + Override this method to handle the MouseUp event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the number of times the mouse button was pressed and released, the mouse coordinates, and the amount the mouse wheel moved. + + + + Override this method to handle the MouseWheel event. + + This class is equivalent to System.Windows.Forms.MouseEventArgs and contains information on a pressed mouse button, the mouse coordinates, and the amount the mouse wheel moved. + + + + Provides access to the service interface of the wrapper. + + An interface of the wrapper. + + + + Contains utility classes used by DevExpress controls and components. + + + + + Contains options used to fix issues on Microsoft Azure websites. + + + + + Specifies whether or not the PDF export mode is Azure-compatible. + + true if the PDF export is Azure-compatible; otherwise false. + + + + Contains classes that implement the Command pattern. + + + + + Represents a command. + + + + + Determines whether the command can execute in its current state. + + true if the command can execute; otherwise, false. + + + + Gets or sets the type of the object which invokes the command. + + A enumeration value, specifying the object type. + + + + Creates an object defining the command state for the current command. + + An interface that defines the command state. + + + + Gets the text description of a command. + + A string containing the command’s description. + + + + Executes the command on the current command target. + + + + + Performs a command action regardless of a command state. + + An interface defining the command state. + + + + Gets or sets whether the object to which the command is attached is hidden, if the command is disabled. + + true to hide the object with a disabled command; otherwise, false. + + + + Gets an image associated with the command. + + A object representing the associated image. + + + + Gets a key tip associated with the command. + + A string value that is the command key tip. + + + + Gets a larger image associated with the command. + + A object representing the associated image. + + + + Gest the menu caption associated with the current command. + + A string representing the text of the menu item. + + + + Indicates whether a command invokes a modal dialog when executing. + + true if a modal dialog is displayed while executing the command; otherwise, false. By default it is false. + + + + Updates the command state. + + An interface defining the state of a command. + + + + Lists the command sources. + + + + + The command is issued from the keyboard. + + + + + The command is issued from the menu. + + + + + The command is issued using a mouse. + + + + + The type of the command source is not known. + + + + + Defines a command state. + + + + + Gets or sets the checked state of the command. + + true if the command state is checked; otherwise, false. + + + + Gets or sets the value used by a command. + + An object representing the value used by a command. + + + + Gets or sets whether the command is enabled. + + true to enable the command; otherwise, false. + + + + Gets or sets whether the UI element to which the command is attached is visible. + + true to display the UI element; otherwise, false. + + + + Contains classes that serve as the base for objects implementing particular aspects of DevExpress controls’ functionality. + + + + + Provides data for the events that fire after option changes . + + + + + Creates a new object with default values. + + + + + Creates a new object. + + A value representing the name of the option whose value has been changed. This value is assigned to the BaseOptionChangedEventArgs.Name property. + A value representing the option’s previous value. This value is assigned to the BaseOptionChangedEventArgs.OldValue property. + A value representing the option’s current value. This value is assigned to the BaseOptionChangedEventArgs.NewValue property. + + + + Gets the name of the option whose value has been changed. + + A value representing the option’s name. + + + + Gets or sets the option’s current value. + + A value representing the option’s current value. + + + + Gets the option’s previous value. + + A value representing the option’s previous value. + + + + Represents a method that will handle the event raised after the option has been changed. + + The event sender. + A object that contains data related to the event. + + + + Serves as a base for classes representing options. + + + + + Creates a new object. + + + + + Initializes a new instance of the class. + + An object that implements the IViewBagOwner interface. + The string value. + + + + Copies all settings from the options object passed as a parameter. + + A descendant whose settings are assigned to the current object. + + + + Locks the object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Resets all options to their default values. + + + + + Returns a string representing the currently enabled options. + + A value representing the currently enabled options. “” (String.Empty) if no option is enabled. + + + + Lists values which specify the validity of a condition (indicates whether the condition is true or false). + + + + + The value is specified by a global option or a higher-level object. + + + + + The value is false. + + + + + The value is true. + + + + + Represents the universal collection, which may be used as a base class for other collection classes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides indexed access to individual items in the collection. + + A zero-based integer specifying the desired item’s position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + A <T> object which represents the item at the specified position. + + + + Represents the universal collection, which may be used as a base class for other collection classes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified capacity. + + An integer value representing the number of elements that the collection can contain. This value is assigned to the DXCollectionBase<T>.Capacity property. + + + + Adds the specified object to the collection. + + A <T> object to append to the collection. + An integer value indicating the position into which the new element was inserted. + + + + Adds a collection of elements to the end of the collection. + + A object which represents the collection of elements to append to the collection. + + + + Gets or sets the number of elements that the can contain. + + An integer value representing the number of elements that the collection can contain. + + + + Removes all objects from the instance. + + + + + Determines whether the collection contains the specified item. + + A <T> object to locate in the collection. + true if the collection contains the specified item; otherwise, false. + + + + Copies all the elements from the instance to a one-dimensional array, starting at the specified index of the target array. + + A one-dimensional array of <T> objects. + An integer value specifying the zero-based index in the target array at which copying begins. + + + + Gets the number of elements contained in the instance. + + An integer value representing the number of elements contained in the collection. + + + + Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire . + + The delegate that defines the conditions of the element to search for. + The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. + + + + Performs the specified action on each element of the . + + The <T> delegate to perform on each element of the . + + + + Returns an enumerator that iterates through the instance. + + A for the instance. + + + + Returns the zero-based index of the specified element in the collection. + + A <T> object to locate in the collection. + An integer value representing the position of the specified element in the collection. + + + + Inserts the specified element into the collection at the specified position. + + An integer value which represents the zero-based index at which the element should be inserted. + A <T> object to insert into the collection. + + + + Removes the specified element from the collection. + + A <T> object to be removed from the collection. + true if the specified element has been successfully removed from the collection; false if the specified element has not been found within the collection. + + + + Removes the element at the specified index of the instance. + + A zero-based integer specifying the index of the object to remove. If it’s negative or exceeds the number of elements, an exception is raised. + + + + Sorts the elements in the entire using the specified comparer. + + The implementation to use when comparing elements. + + + + Copies the elements to a new array. + + An array containing the DXCollectionBase<T> elements. + + + + Gets or sets the type of an object, which provides uniqueness for the current . + + A DevExpress.Utils.DXCollectionUniquenessProviderType instance. + + + + Contains types related to pop-up filter menus, filter editors, filter panels, etc. + + + + + Lists values of localized strings. See the class description to learn more. + + + + + Return value: “Values above the average”. + + + + + Return value: “Above Average”. + + + + + Return value: “After a date”. + + + + + Return value: “After”. + + + + + Return value: “Dates within a range”. + + + + + Return value: “All Dates In The Period”. + + + + + Return value: “April”. + + + + + Return value: “April”. + + + + + Return value: “August”. + + + + + Return value: “August”. + + + + + Return value: “Prior to a date”. + + + + + Return value: “Before”. + + + + + Return value: “Starts with a specific text”. + + + + + Return value: “Begins With”. + + + + + Return value: “Values below the average”. + + + + + Return value: “Below Average”. + + + + + Return value: “Values within a range”. + + + + + Return value: “Between”. + + + + + Return value: “The lowest values”. + + + + + Return value: “Bottom N”. + + + + + Return value: “Contains a specific text”. + + + + + Return value: “Contains”. + + + + + Return value: “Two conditions combined by the AND or OR operators”. + + + + + Return value: “Custom Filter”. + + + + + Return value: “Common date ranges”. + + + + + Return value: “Specific Date Periods”. + + + + + Return value: “December”. + + + + + Return value: “December”. + + + + + Return value: “Does not start with a specific text”. + + + + + Return value: “Does Not Begin With”. + + + + + Return value: “Does not contain a specific text”. + + + + + Return value: “Does not contain”. + + + + + Return value: “Does not end with a specific text”. + + + + + Return value: “Does Not End With”. + + + + + Return value: “Does not equal a value”. + + + + + Return value: “Does Not Equal”. + + + + + Return value: “Ends with a specific text”. + + + + + Return value: “Ends With”. + + + + + Return value: “Equals a value”. + + + + + Return value: “Equals”. + + + + + Return value: “February”. + + + + + Return value: “February”. + + + + + Return value: “Greater than a value”. + + + + + Return value: “Greater Than”. + + + + + Return value: “Greater than or equal to a value”. + + + + + Return value: “Greater Than Or Equal To”. + + + + + Return value: “Empty or not specified”. + + + + + Return value: “Is Blank”. + + + + + Return value: “Not empty”. + + + + + Return value: “Is Not Blank”. + + + + + Return value: “Not empty”. + + + + + Return value: “Is Not Null”. + + + + + Return value: “Is empty”. + + + + + Return value: “Is Null”. + + + + + Return value: “The same date”. + + + + + Return value: “Is Same Day”. + + + + + Return value: “January”. + + + + + Return value: “January”. + + + + + Return value: “July”. + + + + + Return value: “July”. + + + + + Return value: “June”. + + + + + Return value: “June”. + + + + + Return value: “Last month”. + + + + + Return value: “Last Month”. + + + + + Return value: “Last quarter”. + + + + + Return value: “Last Quarter”. + + + + + Return value: “Last week”. + + + + + Return value: “Last Week”. + + + + + Return value: “Last year”. + + + + + Return value: “Last Year”. + + + + + Return value: “Less than a value”. + + + + + Return value: “Less Than”. + + + + + Return value: “Less then or equal to a value”. + + + + + Return value: “Less Than Or Equal To”. + + + + + Return value: “March”. + + + + + Return value: “March”. + + + + + Return value: “May”. + + + + + Return value: “May”. + + + + + Return value: “Next month”. + + + + + Return value: “Next Month”. + + + + + Return value: “Next quarter”. + + + + + Return value: “Next Quarter”. + + + + + Return value: “Next week”. + + + + + Return value: “Next Week”. + + + + + Return value: “Next year”. + + + + + Return value: “Next Year”. + + + + + Return value: “Choose One Description”. + + + + + Return value: “Choose One”. + + + + + Return value: “November”. + + + + + Return value: “November”. + + + + + Return value: “October”. + + + + + Return value: “October”. + + + + + Return value: “First quarter”. + + + + + Return value: “Quarter 1”. + + + + + Return value: “Second quarter”. + + + + + Return value: “Quarter 2”. + + + + + Return value: “Third quarter”. + + + + + Return value: “Quarter 3”. + + + + + Return value: “Fourth quarter”. + + + + + Return value: “Quarter 4”. + + + + + Return value: “Filters Description”. + + + + + Return value: “Filters”. + + + + + Return value: “Date Filters Description”. + + + + + Return value: “Date Filters”. + + + + + Return value: “Filters Description”. + + + + + Return value: “Filters”. + + + + + Return value: “September”. + + + + + Return value: “September”. + + + + + Return value: “Items Description”. + + + + + Return value: “Items”. + + + + + Return value: “Percents Description”. + + + + + Return value: “Percents”. + + + + + Return value: “Numeric Filters Description”. + + + + + Return value: “Numeric Filters”. + + + + + Return value: “Text Filters Description”. + + + + + Return value: “Text Filters”. + + + + + Return value: “This month”. + + + + + Return value: “This Month”. + + + + + Return value: “This quarter”. + + + + + Return value: “This Quarter”. + + + + + Return value: “This week”. + + + + + Return value: “This Week”. + + + + + Return value: “This year”. + + + + + Return value: “This year”. + + + + + Return value: “Today”. + + + + + Return value: “Today”. + + + + + Return value: “Tomorrow”. + + + + + Return value: “Tomorrow”. + + + + + Return value: “The highest values”. + + + + + Return value: “Top N”. + + + + + Return value: “Predefined Filters”. + + + + + Return value: “Predefined Filters”. + + + + + Return value: “From the beginning of the year to the present”. + + + + + Return value: “Year To Date”. + + + + + Return value: “Yesterday”. + + + + + Return value: “Yesterday”. + + + + + Return value: “First”. + + + + + Return value: “Choose one…”. + + + + + Return value: “Enter a date…”. + + + + + Return value: “Enter a value…”. + + + + + Return value: “Enter text to search…”. + + + + + Return value: “Select a date…”. + + + + + Return value: “Select a value…”. + + + + + Return value: “Second”. + + + + + Return value: “Type”. + + + + + Return value: “Value”. + + + + + Return value: “Clear Filter”. + + + + + Return value: “Close”. + + + + + Return value: “Values”. + + + + + Allows you to localize filter menu elements. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides data for the ColumnView.FilterPopupExcelParseFilterCriteria, TreeList.FilterPopupExcelParseFilterCriteria, VGridControl.FilterPopupExcelParseFilterCriteria and PivotGridControl.FilterPopupExcelParseFilterCriteria events. + + + + + Gets the applied filter criteria. + + An object that specifies the filter criteria. + + + + Gets the name of the processed data field or the full path to the data field through object relationships. + + A string value that specifies the name of the processed data field or the full path to the data field through object relationships. + + + + Selects the data value that corresponds to the blank value. + + true, if the data value is successfully selected; otherwise, false. + + + + Selects the data value that corresponds to the empty string value. + + true, if the data value is successfully selected; otherwise, false. + + + + Selects the data values that do not correspond to the blank value. + + true, if the data values are successfully selected; otherwise, false. + + + + Selects the data values that do not correspond to the empty string value. + + true, if the data values are successfully selected; otherwise, false. + + + + Selects the data values that do not correspond to the null value. + + true, if the data values are successfully selected; otherwise, false. + + + + Selects the data value that corresponds to the null value. + + true, if the data value is successfully selected; otherwise, false. + + + + Selects the specified range of values. + + An object that specifies the start value of the range. + An object that specifies the end value of the range. + true, if the data value range is successfully selected; otherwise, false. + + + + Selects the specified range of values. + + An object that specifies the start value of the range. + An object that specifies the end value of the range. + The data type. + true, if the data value range is successfully selected; otherwise, false. + + + + For internal use. + + For internal use. + For internal use. + For internal use. + + + + Selects the specified value. + + An object that specifies the value by which data is filtered. + true, to select values that are not specified; otherwise, false. + true, if the data value is successfully selected; otherwise, false. + + + + Selects the specified value. + + An object that specifies the value by which data is filtered. + The data type. + true, if the data value is successfully selected; otherwise, false. + + + + Selects the specified values. + + An array of values by which data is filtered. + true, if the data values are successfully selected; otherwise, false. + + + + Selects the specified values. + + An object that specifies the collection of values by which data is filtered. + The data type. + true, if the data values are successfully selected; otherwise, false. + + + + Selects the specified values and the “Blanks” value. + + An array of values by which data is filtered. + true, if the data values are successfully selected; otherwise, false. + + + + Selects the specified values and the “Blanks” value. + + An object that specifies the collection of values by which data is filtered. + The data type. + true, if the data values are successfully selected; otherwise, false. + + + + Gets an object that specifies the filter menu view model. + + An object that specifies the filter menu view model. + + + + Provides formatting settings. + + + + + Creates an instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A DevExpress.Utils.IComponentLoading object. + An object that implements the IViewBagOwner interface. + The string value. + + + + Initializes a new instance of the class with the specified settings. + + A DevExpress.Utils.IComponentLoading object. + + + + Initializes a new instance of the class. + + An object that implements the IViewBagOwner interface. + The string value. + + + + Gets or sets whether a value for the FormatInfo.Format property should be determined each time the property is accessed. + + true if the value for the FormatInfo.Format property should be determined each time the property is accessed. + + + + Copies properties of the specified object to the current object. + + The object whose properties must be copied. + + + + Occurs on changing properties of the current class object. + + + + + Gets a object with default settings. + + The object with default property values. + + + + Gets or sets the object which specifies how values should be formatted. + + The IFormatProvider object which specifies how values should be formatted. + + + + Gets the pattern for formatting values. + + The string representing the format pattern. + + + + Gets or sets the type of formatting specified by the current object. + + One of values specifying the formatting type. + + + + Gets the value formatted according to the format pattern and using the format provider settings. + + The value to format. + The text representation of the specified value according to settings of the current object. + + + + Returns the actual format string. + + The actual format string. + + + + Tests whether properties of the current object are set to default values. + + true if the object properties are set to default values; otherwise,false. + + + + Compares properties of the current object with settings of the specified object. + + The object whose properties are compared. + true if properties of the current object equal to corresponding properties of the info parameter. + + + + The method supports the internal .NET infrastructure and you must not call it from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Performs actions when the FormatInfo.FormatType property changes. + + + + + Reverts properties of the current object to default values. + + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Returns a string that represents the current object. + + A value that represents the current object. + + + + The method supports the internal .NET infrastructure and you must not call it from your code. + + + + + Enumerates values for the FormatInfo.FormatType property. + + + + + Use Custom to format string values. + + Use Custom when assigning a custom to the FormatInfo.Format property. + + Setting FormatInfo.FormatType to Custom does not change the FormatInfo.Format and FormatInfo.FormatString property values. + + + + + Specifies that values should be formatted as the type. + Setting FormatInfo.FormatType to DateTime assigns the static format provider to the FormatInfo.Format property. This defines the format provider for the current culture. + Also FormatInfo.FormatString is set to “d” (short date pattern). + + + + + No formatting is performed. + Setting the FormatInfo.FormatType property to None clears the FormatInfo.FormatString property and sets the FormatInfo.Format object to null. + + + + + Specifies that values should be formatted as numbers. + Setting FormatInfo.FormatType to Numeric assigns the static System.Globalization.NumberFormatInfo.CurrentInfo format provider to the FormatInfo.Format property. This defines the format provider for the current culture. + Also FormatInfo.FormatString is set to an empty string. + + + + + Specifies the horizontal alignment of an object or text in a control. + + + + + Centers an object or text within a region. + + + + + Places an object or text at the default position, which is determined by a control. + + + + + Places an object/text at a far position. + + + + + Places an object/text at a near position. + + + + + Contains classes that provide support for the “Inversion of Control” software design pattern in DevExpress products. + + + + + Enables you to register factories that are used to create object instances. + + + + + Initializes a new instance of the class with the specified factory. + + A function, specifying the required . + + + + Modifies the registration so that a new dependency will be created on each IntegrityContainer.Resolve method call. + + + + + Releases all resources used by . + + + + + Gets the cached resolved instance for a resolved non-transient dependency. + + A value. + + + + Gets the flag for a transient registration. + + A Boolean value. + + + + Provides a container registration for dependencies that are registered by passing an instance (using the IntegrityContainer.RegisterInstance method). + + + + + Initializes a new instance of the class with the specified instance. + + A value. + + + + Gets the passed reference as a dependency. + + A value. + + + + A dependency injection container. + + + + + Initializes a new instance of the class with the default settings. + + + + + Releases all resources used by . + + + + + Registers a delegate to resolve an instance of the specified type with a specified TServiceType key. + + A function, specifying the type to resolve. + A object. + + + + Registers a delegate with the specified container as an argument to resolve an instance of the specified type with a corresponding TServiceType key. + + A function, specifying the type to resolve. + A object. + + + + Registers the specified instance as a singleton with the specified serviceType key. + + A object. + A value. + An object. + + + + Registers the specified instance as a singleton with the specified TServiceType key. + + A value. + An object. + + + + Registers the specified concreteType with the specified serviceType key. + + A object. + A object. + A object. + + + + Registers the specified TConcreteType as a dependency. + + A object. + + + + Registers the specified TConcreteType with the specified TServiceType key. + + A object. + + + + Gets an instance with the specified serviceType key. + + A object. + A value. + + + + Gets an instance of the specified type with a corresponding TServiceType key. + + A value. + + + + Provides an abstract container registration. + + + + + Occurs if there is an error during registration of a type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified message and exception details. + + A value, specifying the message displayed when a database connection fails. + A object, specifying the error details. + + + + Initializes a new instance of the class with the specified error message. + + A value, specifying the error message. + + + + Occurs if there is an error during request of a dependency. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified message and exception details. + + A value, specifying the message displayed when a database connection fails. + A object, specifying the error details. + + + + Initializes a new instance of the class with the specified error message. + + A value, specifying the error message. + + + + Enables a container registration for dependencies that are registered by type (i.e., by calling the IntegrityContainer.RegisterType methods). + + + + + Initializes a new instance of the class with the specified settings. + + A object. + A object. + + + + Modifies the registration so that a new dependency will be created on each IntegrityContainer.Resolve method call. + + + + + Gets the type of a dependency. + + A object. + + + + Gets the selected constructor to be resolved. + + A object. + + + + Releases all resources used by . + + + + + Gets the cached instance for a resolved non-transient dependency. + + A value. + + + + Gets an object that can be used to synchronize access. + + A value. + + + + Gets the flag for a transient registration. + + A Boolean value. + + + + Gets the registered value for a constructor parameter that was registered using the TypeRegistration.WithCtorArgument methods. + + A value. + A value. + true, if the constructor parameter value has been obtained; otherwise, false. + + + + Registers a constructor parameter value (if it is not registered in the container as a dependency). + + A value, specifying the parameter name. + A value, specifying the parameter value. + A object. + + + + Provides data for events raised when upgrading a control’s layout, allowing you to cancel the upgrade (e.g. BaseView.BeforeLoadLayout, BarManager.BeforeLoadLayout, etc.). + + + + + Initializes a new instance of the class with the specified previous version. + + A specifying the previous version number. This value is assigned to the LayoutUpgradeEventArgs.PreviousVersion property. + + + + Gets or sets whether to allow upgrading the control layout. + + true to allow the operation; otherwise, false. + + + + A method that will handle events raised when upgrading a control’s layout, allowing you to cancel the upgrade (e.g. BaseView.BeforeLoadLayout, BarManager.BeforeLoadLayout, etc.). + + The event sender. + A object that contains event data. + + + + Provides data for the events raised when upgrading a control’s layout (e.g., BaseView.LayoutUpgrade, BarManager.LayoutUpgrade, etc.). + + + + + Initializes a new instance of the class with the specified settings. + + A value used to initialize the LayoutUpgradeEventArgs.PreviousVersion property. + A value used to initialize the LayoutUpgradeEventArgs.NewHiddenItems property. + + + + Initializes a new instance of the class with the specified previous version. + + A specifying the previous version number. This value is assigned to the LayoutUpgradeEventArgs.PreviousVersion property. + + + + Returns an array of items that exist in the current control but do not exist in the layout being loaded. These items are hidden. This property is in effect for the . + + An array of items that exist in the current control but do not exist in the layout being loaded. + + + + Returns the textual representation of the previous layout version. + + A representing the previous version of the layout. + + + + A method that will handle events raised when upgrading a control’s layout (e.g., BaseView.LayoutUpgrade, BarManager.LayoutUpgrade, etc.). + + The event sender. + A object that contains event data. + + + + Represents classes, that implement basic functionality for localization of Windows Forms and ASP.NET controls. + + + + + Represents the base class for all localizer classes. + + + + + Gets or sets a localizer object providing localization of the user interface at runtime. + + A descendant, which is used to localize the user interface at runtime. + + + + Fires immediately after the XtraLocalizer<T>.Active property value has been changed. + + + + + Returns a localizer object, which provides resources based on the thread’s language and regional settings (culture). + + An object representing resources based on the thread’s culture. + + + + Creates an XML document, which contains resource strings provided by the current object. + + A object. + + + + Returns an active localizer provider for this object. + + An ActiveLocalizerProvider<T> object. + + + + Gets the string, localized by the current , for the specified user interface element. + + A T enumeration value specifying the UI element whose caption (text) is to be localized. + A representing the text to be displayed within the specified UI element. + + + + Returns the name of the language currently used by this localizer object. + + A value that specifies the language of the user interface localization. + + + + Raises the XtraLocalizer<T>.ActiveChanged event. + + + + + Sets an active localizer provider for this object. + + An ActiveLocalizerProvider<T> object. + + + + Saves the current ‘s resources to the specified XML file. + + A specifying the file name (including the file path), to which all localization resources will be saved. + + + + Represents a base class for collections that are able to send update notifications. + + + + + Initializes a new instance of the class with the default settings. + + + + + Adds a collection of objects to the end of the current collection. + + An object exposing the interface, which represents the collection of objects to append. + + + + Locks the , preventing change notifications (and visual updates) from being raised by the object until the EndUpdate or CancelUpdate method is called. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Occurs when the collection is changed. + + + + + This event occurs when the collection is about to change. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets whether the collection has been locked for updating. + + true if the collection is locked; otherwise, false. + + + + Contains options that specify how column specific settings are stored to and restored from storage (a stream, xml file or the system registry). + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether columns that exist in the current control but do not exist in a layout when it is restored should be retained. + + true to retain columns that exist in the current control’s layout but do not exist in the layout being restored; false to remove such columns. + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the columns that exist in a layout when it is restored but that do not exist in the current control should be discarded or added to the control. + + true to discard the columns that exist in the layout being restored but do not exist in the current control; false to add these columns to the control. + + + + Gets or sets whether all the settings of a control’s columns/bands (except for the appearance settings) are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if all the settings of a control’s columns/bands are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether the appearance settings of the columns and bands are also stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if the appearance settings of the columns and bands are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether the position, width and visibility of the columns and bands are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if the position, width and visibility of columns and bands are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Represents the base class for classes which contain the options that are responsible for how the control’s layout is stored to and restored from storage (a stream, xml file or system registry). + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies settings from the specified object to the current object. + + An object whose settings are copied to the current object. + + + + Returns an object whose settings indicate that the full layout of the control should be stored to and restored from storage (a stream, xml file or system registry). + + A object whose settings indicate that the full layout of the control should be stored to/restored from storage. + + + + Gets or sets the version of the layout. + + A string representing the version of the layout. + + + + Gets whether the settings should be persisted. + + The component that owns the current settings. + true, if the settings should be persisted; otherwise, false. + + + + Contains options that specify how a control’s layout is stored to and restored from storage (a stream, xml file or system registry). + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Contains options that specify how the columns’ and bands’ settings are stored to and restored from storage (a stream, xml file or system registry). + + An object that specifies how the columns’ and bands’ settings are stored to and restored from storage. + + + + Resets all options to their default values. + + + + + Gets or sets whether all the control’s settings (except for the appearance settings and format rules) are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if all the control’s settings are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from the storage; otherwise, false. + + + + Gets or sets whether the control’s appearance settings are also stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if the control’s appearance settings are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether the control’s grouping, sorting, filtering settings and summaries are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if the control’s grouping, sorting, filtering settings and summaries are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether MS Excel-style conditional formatting rules are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if MS Excel-style conditional formatting rules are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether the control’s visual options are stored when the layout is saved to storage and restored when the layout is restored from storage. + + true if the control’s visual options are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Represents a point with floating X and Y values. + + + + + For internal use only. Initializes a new instance of the class. + + + + + For internal use only. Initializes a new instance of the class. + + A value. + A value. + + + + For internal use only. Represents an empty point. + + + + + Determines whether or not the specified object is equal to the current instance. + + The object specifying a instance to compare with the current object. + true if the specified object is equal to the current instance. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + For internal use only. Checks whether the current point object is empty. + + true if the point is empty; otherwise, false. + + + + Adds the specified values to PointFloat.X and PointFloat.Y. + + A value to be added to PointFloat.X. + A value to be added to PointFloat.Y. + + + + For internal use. Returns the textual representation of . + + A value. + + + + For internal use. Specifies the X-coordinate of the object. + + A value. + + + + For internal use. Specifies the Y-coordinate of the object. + + A value. + + + + Contains helper classes that extend serialization capabilities of DevExpress controls. + + + + + When implemented, specifies a converter used to serialize/deserialize arbitrary objects in a custom manner. + + + + + When implemented, returns whether the converter can serialize/deserialize objects of the specified type. + + A that specifies the type to check. + true if the converter can serialize/deserialize objects of the specified type; otherwise, false. + + + + When implemented, deserializes an object of the specified type from the specified string. + + A that specifies the type of object to deserialize. + A that represents the serialized object. + A deserialized object. + + + + When implemented, returns the type by its full name. + + A that specifies the full name of the type to return. + A that identifies the type whose full name is specified by the typeName parameter. + + + + When implemented, serializes the specified object of the specified type. + + A that specifies the type of the object to serialize. + The object to serialize. + A that represents the serialized object. + + + + Serves as a base class for classes that retrieve and save appointment information from and to XML data objects. + + + + + Generate an XML string that contains information about a persistent object or collection (reminders, resources, etc.). + + An XML string. + + + + Provides an API that supports vector images. + + + + + A vector image. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Creates a vector image from the given stream. + + A stream from which the vector icon should be created. + + + + Creates a vector icon from a resource. + + A Type of resource assembly. + Image name. + + + + Copies this vector icon. + + The vector image copy. + + + + You cannot modify SvgImage objects directly. Instead, you need to create their copies and modify them in process. + + A Delegate that modifies the icon. + New vector image copy. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + Provides access to elements (primitives) from which this vector image consists. + + A List of vector image elements. + + + + Creates a new SvgImage object from a vector image on local storage. + + A path to the image file. + The SvgImage object created from the given file. + + + + Creates a new SvgImage object from a vector image stored in project resources. + + The name an icon has in resources. + The assembly name. + A newly created SvgImage. + + + + Creates a new SvgImage object from a vector image stored in a stream. + + The stream that stores the image. + A newly created SvgImage object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + Returns the image height. + + The image height. + + + + Returns the horizontal image offset. + + The horizontal image offset. + + + + Returns the vertical image offset. + + The vertical image offset. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + Saves this vector image to the specific file. + + A path to the file where this vector icon should be stored. + + + + Applies a transformation matrix to this vector image. + + The transformation matrix to apply. + The modified image. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + Gets or sets a unique image identifier. + + An Object that identifies this image. + + + + Returns the collection of image tags that are not supported by DevExpress controls. + + Stores unsupported image tags. + + + + Returns the image width. + + The image width. + + + + Lists the values specifying whether a report control can load images using the “file://“ protocol. + + + + + Enables loading of images from custom directories (defined using the UrlAccessSecurityLevelSetting.RegisterCustomBaseDirectories or UrlAccessSecurityLevelSetting.RegisterCustomCallback method). + + + + + Enables loading of images from an application’s working directory (defined by the AppDomain.CurrentDomain.BaseDirectory property). + + + + + Enables loading of any image from any directory. + + + + + Forbids loading images using the “file://“ protocol (only the “http://“, “https://“ and “ftp://“ protocols are supported). + + + + + Specifies the security settings for resolving URL’s in a web application. + + + + + Enables using the “file://“ protocol for loading images to the specified directories. + + An array of values, specifying the custom directories. + true, if loading images to custom directories is enabled; otherwise, false. + + + + Enables loading images to the protocols defined in the specified callback. + + A function, specifying a custom callback. + true, if loading images to custom directories is enabled; otherwise, false. + + + + For internal use. + + + + + Specifies whether a report control allows loading images using the “file://“ protocol. + + A enumeration value. + + + + Specifies the vertical alignment of an object or text in a control. + + + + + Places the text to the bottom of an object. + + + + + Centers the text within an object. + + + + + Places the text to its default position. The default position is in the center of an object. + + + + + Places the text to the top of an object. + + + + + Enumerates wrapping modes. + + + + + Default wrapping mode. The actual wrapping mode is determined by a control. + + + + + The word wrapping feature is disabled. + + + + + The word wrapping feature is enabled. + + + + + Contains classes implementing the common ViewState management functionality for DevExpress Web controls. + + + + + Represents a base for classes providing different options. + + + + + Initializes a new instance of the class with the default settings. + + + + + Contains classes that support the infrastructure of the eXpress Persistent Objects. + + + + + Contains classes that handle operations on a data store. + + + + + Lists the values that specify the action which is performed when a session is connected to a data store. + + + + + A session will try to automatically create the database if it doesn’t exist. It will also create or update the database schema for any persistent classes currently being used. + + + + + A session will not automatically create the database or update the database schema. The database schema is still queried and checked to match the currently used persistent class metadata. + + + + + A session will never query the database for schema to validate against persistent class metadata. This will suppress the SchemaCorrectionNeededException, but a database error may occur during data operations if the schema is not compatible with run-time persistent classes metadata. + + + + + A session will automatically create or update the database schema for the persistent classes currently being used. If the database doesn’t exist, it won’t be created by a session. + + + + + Serves as the base class for the classes that represent statements. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Returns the names of the tables that are referenced in the statement. + + An array of strings that specify the names of the tables that are referenced in the statement. + + + + Returns the names of the tables that are referenced in the specified statements. + + An array of descendants that represents statements. + An array of strings that specify the names of the tables that are referenced in the specified statements. + + + + The collection of operands. + + + + + Contains values that specify the command pool behavior. + + + + + Pooling of prepared (or compiled) commands in the scope of the database transaction. + + + + + No command pooling. + + + + + Pooling of prepared (or compiled) commands in the scope of the database transaction. + + + + + Pooling of commands in the scope of the database transaction. The method is not called for commands. + + + + + Implements the base functionality for SQL-based data store adapters, including the and other adapters listed in the Database Systems Supported by XPO topic. + + + + + Gets a collection of custom aggregate functions supplied by the current metadata provider. + + A collection of custom aggregate functions. + + + + Specifies the timeout value passed to the IDbCommand.CommandTimeout property of each created command, in seconds. + + + + + Searches custom aggregate functions registered in an application via the and method calls for a function with the specified name. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + An object that corresponds to the aggregateName, if found; otherwise, null (Nothing in Visual Basic). + + + + Specifies the timeout value passed to the IDbCommand.CommandTimeout property, in seconds. Can be overridden by the ConnectionProviderSql.DefaultCommandTimeout field. The default is 300. + + + + + Specifies how connection providers initialize command parameters. Use the property to change this setting for a specific connection provider. + + A enumeration value. Specifies how to initialize command parameters. + + + + This property is now obsolete. Use instead. + + Specifies whether connection providers initialize the , , , and properties. The default value is false. + + + + Specifies how a connection provider initializes command parameters. + + A enumeration value. Specifies how to initialize command parameters. + + + + Registers a custom aggregate function to use in any -based criteria in your application. + + A custom aggregate function to register. + + + + Registers custom aggregate functions to use in any -based criteria in your application. + + A collection of custom aggregate functions to register. + + + + Unregisters a specified custom aggregate function from use in any -based connection provider in your application. + + A custom aggregate function to unregister. + true, if the customAggregate was unregistered successfully; otherwise, false. + + + + Unregisters a custom aggregate function with the specified name from use in any -based connection provider in your application. + + A custom aggregate function’s name. This value cannot be null (Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single. + true, if a custom aggregate function whose name matches the functionName was unregistered successfully; otherwise, false. + + + + This property is now obsolete. Use instead. + + Specifies whether a connection provider initializes the , , , and properties. The default value is false. + + + + The Node element that is used to connect to a cached data store‘s Root or Node element. + + + + + Initializes a new instance of the class with default settings and a specified parent cache element. + + A parent Root or Node element specifying the element to which the current Node is connected. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Synchronizes the Node’s table update information with the Root element ( or ). + + + + + Applies specified configuration settings to a cached data store. + + A object containing cache configuration settings. + + + + Returns information that describes the structure of specified tables in a cached data store. + + An array of table names whose information should be retrieved. + An array of objects that describe the structure of the requested tables. + + + + Returns a list of all the tables available in a cached data store. + + true, to include views; otherwise, false. + An array of the table names in the cached data store. + + + + For internal use. + + + + + For internal use. + + + + + Specifies the time period (also known as latency) between regular contacts that the current Node makes to its parent element for up-to-date table update information. The default value is 30 seconds. + + + + + Specifies the minimum number of query results to retain within the current Node’s cache during its automatic purge. The default value is 16. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + The Node element that is used to connect to a cached data store‘s Root or Node element located on the local host. + + + + + Initializes a new instance of the class with default settings and a specified parent cache element. + + A parent Root or Node element specifying the element (located on the same computer) to which the current Node is connected. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + The Root element that is used to connect Node elements to a cached data store. + + + + + Initializes a new instance of the class with a specified data store provider connected to a data store to be cached. + + A object which provides connection to a data store to be cached. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Applies specified configuration settings to a cached data store. + + A object containing cache configuration settings. + + + + Returns information that describes the structure of specified tables in a cached data store. + + An array of table names whose information should be retrieved. + An array of objects that describe the structure of the requested tables. + + + + Returns a list of all the tables available in a cached data store. + + true, to include views; otherwise, false + An array of the table names in the cached data store. + + + + The base class for data store providers (the objects providing access to specific data stores). + + + + + Returns which operations are performed when a data store is accessed for the first time. + + An enumeration value that specifies the action which is performed when a data store is accessed for the first time. + + + + Returns registered provider factories. + + An array of provider factories that are registered for the current data store. + + + + Creates a data store based on specified settings. + + An object which implements the interface. + An enumeration value which specifies the action which is performed when connecting to the created data store. The specified value initializes the data store’s IDataStore.AutoCreateOption property. + A data store implementing the interface, which uses the connection to access a database. + + + + Creates a data store based on specified settings. + + A specifying the provider type. Normally, each provider returns its type via the XpoProviderTypeString property. + The connection string which is used to instantiate a connection provider. + An enumeration value which specifies the action which is performed when connecting to the created data store. The specified value initializes the data store’s IDataStore.AutoCreateOption property. + An array of objects that implement the System.IDisposable interface. These objects are automatically disposed of when the created data store is disconnected. + A data store implementing the interface, which uses the connection to access a database. + + + + Registers a data store provider using a specified connection type name and a procedure that establishes a connection for the provider. + + A specifying a connection type name, including a namespace. For instance, the defines this parameter as “System.Data.SqlClient.SqlConnection”. + A DataStoreCreationFromConnectionDelegate delegate to be called when the data store provider is created and connected to a database using a connection of the specified type. + + + + Registers a data store provider using a specified name and a procedure that establishes a connection for the provider. + + A that uniquely identifies a data store provider. + A DataStoreCreationFromStringDelegate delegate to be called when the data store provider is created and connected to a database using a connection string. + + + + Registers a specified data store provider factory. + + A ProviderFactory object exposing members required to create a data store provider. + + + + Updates a data store’s schema according to specified settings. + + An array of tables whose structure should be saved in the data store. + + + + Returns a parameter name used to denote a provider type in a connection string. The default value is “XpoProvider”. + + + + + Enables operations performed by a specific object to be logged. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents a tracked data store. + A object that will log data-aware operations performed on the tracked data store + + + + Gets a writer that logs the data-aware operations performed on the tracked data store. + + A object that logs the data-aware operations performed on the tracked data store + + + + The schema of a column in a . + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + + + + Specifies the column’s type. + + + + + Specifies the name of the column data type. + + + + + Gets the column type of the specified runtime type. + + A object that represents the exact runtime type. + true to return the DBColumnType.Unknown value if the specified type cannot be identified; false to raise the exception. + A DevExpress.Xpo.DB.DBColumnType enumeration value that corresponds to the specified runtime type. + + + + Gets the column type of the specified runtime type. + + A object that represents the exact runtime type. + A enumeration value that corresponds to the specified runtime type. + + + + Gets the runtime type of the specified column type. + + One of the enumeration values. + A object that represents the exact runtime type of the specified column type. + + + + true if the value of the column increments automatically; otherwise, false. The default value is false. + + + + + true if the column is the key column; otherwise, false. + + + + + Indicates whether values of the specified column type can be saved to a database. + + One of the enumeration values. + true if values of the specified column type can be saved to a database; otherwise, false. + + + + Indicates whether values of the specified runtime type can be saved to a database. + + A object that represents the exact runtime type. + true if values of the specified type can be saved to a database; otherwise, false. + + + + Specifies the column’s name. + + + + + The maximum length of a text column. This is ignored for non-text columns. + + + + + Lists the supported database column types. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the array data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates the data type. + + + + + Indicates a non-standard data type. + + + + + The foreign key of a table. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A collection of strings that specify the names of columns that function as foreign keys for a table. This value is assigned to the DBTableMultiColumnGadget.Columns property. + A value that specifies the name of a primary key table. This value is assigned to the DBForeignKey.PrimaryKeyTable field. + A collection of strings that specify the names of columns that function as primary keys for a table. This value is assigned to the DBForeignKey.PrimaryKeyTableKeyColumns field. + + + + Specifies the name of a primary key table. + + + + + A collection of strings that specify the names of columns that function as primary keys for a table. + + + + + For internal use. An index of a table. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A collection of strings that identify the columns that function as primary keys for a table. This value is assigned to the DBTableMultiColumnGadget.Columns property. + true if the index must be unique; otherwise, false. This value is assigned to the DBIndex.IsUnique property. + + + + Initializes a new instance of the class with the specified settings. + + A value that is assigned to the DBTableMultiColumnGadget.Name property. + A collection of strings that identify columns that function as primary keys for a table. This value is assigned to the DBTableMultiColumnGadget.Columns property. + true if the index must be unique; otherwise, false. This value is assigned to the DBIndex.IsUnique property. + + + + true if the index must be unique; otherwise, false. If the IsUnique field is set to true, an exception will be thrown when assigning an index that isn’t unique. + + + + + Stores a pair of values, specifying a along with its corresponding name. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A value. + A enumeration value. + + + + A value, specifying the database column name. + + + + + Returns a value, specifying the name and type of the data table column (separated by a white space). + + A value. Example: “OrderDate DateTime“. + + + + A value, specifying the database column type. + + + + + The primary key of a table. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified columns that function as primary keys for a table. + + A collection of strings that identify columns that function as primary keys for a table. This value is assigned to the DBTableMultiColumnGadget.Columns property. + + + + Initializes a new instance of the class with the specified name and columns that function as primary keys for a table. + + A value that is assigned to the DBTableMultiColumnGadget.Name property. + A collection of strings that identify columns that function as primary keys for a table. This value is assigned to the DBTableMultiColumnGadget.Columns property. + + + + A stored procedure. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the collection of a stored procedure’s arguments. + + A collection of values. + + + + A value, specifying the stored procedure name. + + + + + Provides access to the collection of a stored procedure’s result sets. + + A collection of values. + + + + Returns the name. + + Always the DBStoredProcedure.Name value. + + + + Provides information about a stored procedure’s parameter. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A value. This value is assigned to the DBNameTypePair.Name property. + A enumeration value. This value is assigned to the DBNameTypePair.Type property. + A enumeration value. This value is assigned to the DBStoredProcedureArgument.Direction property. + + + + Initializes a new instance of the class with the specified settings. + + A value. + A enumeration value. + + + + A value corresponding to an appropriate object. + + + + + Returns a value, specifying the stored procedure’s parameter direction (within brackets and in uppercase letters) along with the name and type of the parameter (separated by a white space). + + A value. Example: “[INOUT] OrderDate DateTime“. + + + + Lists the directions available for a stored procedure’s parameter. + + + + + Indicates an input parameter of a stored procedure. + + + + + Indicates a bidirectional parameter of a stored procedure. + + + + + Indicates an output parameter of a stored procedure. + + + + + A result set of a stored procedure. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A collection of values. + + + + Provides access to the list of data tables included in a stored procedure’s result sets. + + A collection of values. + + + + Returns a value, specifying the number of data table columns included in the stored procedure’s result set. + + A value. Example: “5 columns“. + + + + A table that stores a persistent object‘s data. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified name. + + A value that specifies the table’s name. This value is assigned to the DBTable.Name property. + + + + Appends a column to the DBTable.Columns collection. + + A object that represents the column to be added to the collection. + + + + Appends a object to the DBTable.ForeignKeys collection. + + A object to be added to the collection. + + + + Appends a object to the DBTable.Indexes collection. + + A object to be added to the collection. + + + + Provides access to the current ‘s column collection. + + A list of objects that represent the columns defined in the current DBTable. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Provides access to the current ‘s foreign keys collection. + + A list of objects that represent the foreign keys defined in the current DBTable. + + + + Creates a new column with the specified name and appends it to the DBTable.Columns collection. + + A value that specifies the column’s name. This value is assigned to the DBColumn.Name property. + A object that represents the new column. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Provides access to the current ‘s indexes collection. + + A list of objects that represent the indexes defined for the current DBTable. + + + + Indicates whether the DBTable.ForeignKeys collection contains the specified object. + + A object to locate in the collection. + true if the collection contains the specified object; otherwise, false. + + + + Indicates whether the DBTable.Indexes collection contains the specified object. + + A object to locate in the collection. + true if the collection contains the specified object; otherwise, false. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Specifies the table’s name. + + + + + Specifies a object that represents a primary keys for the table. The primary key must be unique to identify the record in the table. It’s also possible to have a table with a primary key made up of two or more columns. + + + + + An abstract base class for , and . + + + + + Specifies a collection of strings that are the names of the columns comprising the object. In the descendant class, these columns are primary keys. In , these are foreign keys. In , these are columns comprising the index. + + + + + This member supports the XPO Framework infrastructure and is not intended to be used directly from your code. + + + + + Represents the delete statement. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the table. + A value that identifies the table. This value is assigned to the JoinNode.Alias property. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Returns a string representation of the . + + A string representing the DeleteStatement. + + + + Contains classes that describe exceptions on the datastore level. + + + + + An exception that is thrown when a key or index constraint fails. + + + + + Initializes a new instance of the class with the specified settings. + + A string that specifies the SQL statement that raised the exception. + A string that specifies the parameters for the SQL statement. + An object that represents the inner error. + + + + An exception thrown because an attempt is made to modify a row in a database, but its version doesn’t match the version of the row being posted. + + + + + Initializes a new instance of the class. + + + + + An exception that is thrown when a connection provider cannot identify the type of column to create a column in a data store. + + + + + Initializes a new instance of the class with the specified settings. + + The type of column that cannot be identified. + + + + Gets the type of column that cannot be identified. + + The type of column that cannot be identified. + + + + An exception that is thrown when the storage schema doesn’t match the structure of persistent objects and the schema cannot be modified. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class . + + A SQL statement or the name of the object that raised this exception. + + + + A SQL statement or the name of an object that raised this exception. + + A SQL statement or the name of an object that raised this exception. + + + + An exception that is thrown when an unexpected error occurs during the execution of a SQL statement. + + + + + Initializes a new instance of the class with the specified settings. + + A string that specifies the SQL statement that raised the exception. + A string that specifies the parameters for the SQL statement. + An object that represents the inner error. + + + + Gets a string that represents the parameters for the current SQL statement. + + A string that represents the parameters for the SQL statement. + + + + Gets the SQL statement that raised the exception. + + A string that specifies the SQL statement which raised the exception. + + + + An exception that is thrown when a specific object cannot be created in a data store. + + + + + Initializes a new instance of the class with the specified settings. + + A string that specifies the type of the object that cannot be created. + A string that specifies the name of the object. + A string that specifies the name of the object’s parent. + An object that represents the inner error. + + + + Gets the name of the object that cannot be created. + + The name of the object that cannot be created. + + + + Gets the type of the object that cannot be created. + + A string that specifies the type of the object that cannot be created. + + + + Gets the name of the parent which contains the object that cannot be created. + + The name of the parent. + + + + An exception that is thrown when a database either cannot be created or opened. + + + + + Initializes a new instance of the class with the specified settings. + + A connection string that is used to connect to the database. + An object that represents the inner error. + + + + Contains auxiliary (helper) classes that handle operations on data stores. + + + + + Base class for classes that implement data store caching. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + When implemented by a descendant class, applies specified configuration settings to a cached data store. + + A object containing cache configuration settings. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + The name of a category used to tag data cache operations in XPO logs. The default category name is “DataCache”. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + When implemented by a descendant class, resets or clears any cached information on data store tables (such as table update information and cached query results). + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Contains configuration settings for cached data stores. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified caching scope settings. + + A enumeration value specifying the scope of tables. The specified value is used to initialize the DataCacheConfiguration.Caching property. + An array of table names used to determine the caching scope. The specified value is used to initialize the DataCacheConfiguration.Tables property. + + + + Specifies the scope of table settings in the current configuration. + + A enumeration value which identifies if tables specified via the DataCacheConfiguration.Tables property are included in or excluded from the caching scope. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Returns a shallow instance. + + A object instance with no configuration settings specified. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Specifies tables to be used to determine the caching scope of the current configuration. + + An array of table names specifying the tables to be included in or excluded from the caching scope. + + + + Lists the values that specify the scope of cache configuration settings in cached data stores. + + + + + All tables will be cached, regardless of their inclusion in the configuration settings. + + + + + Only tables specified in configuration settings will be cached. + + + + + All tables except for the tables specified in configuration settings will be cached. + + + + + A cached data store‘s Root element ( or ) state information stored in a Node element ( or ). + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Information on the last state of a cached data store‘s Root element ( or ), including data modification results. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Information on the last state of a cached data store‘s Root element ( or ). + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Information on the last state of a cached data store‘s Root element ( or ), including query results. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Information on the last state of a cached data store‘s Root element ( or ), including schema update results. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Information on the age of tables cached via a object. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + The interface for objects that need to interact with a cached data store. + + + + + Provides methods for transferring data between cached data store elements. + + + + + When implemented by a class, executes specified modification statements against a cached data store, notifies about affected tables and returns the operation result. + + A Root element’s state stored by a specific cache Node. + An array of data modification statements. + A denoting the result of the data modifications. + + + + When implemented by a class, informs a cached data store‘s Root element ( or ) about specific modified tables. + + A Root element’s state stored by a specific cache Node. + An array of table names specifying modified tables. + A object specifying a Root element’s state. + + + + When implemented by a class, synchronizes table update information with a cached data store‘s Root element ( or ). + + A Root element’s state stored by a specific cache Node. + A object specifying a Root element’s state. + + + + When implemented by a class, fetches data from a cached data store using specified query statements and returns the operation result. + + A Root element’s state stored by a specific cache Node. + An array of query statements. + A object denoting the result of the data fetch. + + + + When implemented by a class, updates a cached data store‘s schema according to specified settings and returns the operation result. + + A Root element’s state stored by a specific cache Node. + An array of tables whose structure should be saved in the cached data store. + true if the schema should not be created if the table that corresponds to the first item in the tables array doesn’t exist in the cached data store; otherwise, false. + An denoting the result of the update operation. + + + + The interface for objects that need to interact with a data store. + + + + + When implemented by a class, returns which operations are performed when a data store is accessed for the first time. + + An value that specifies which operations are performed when a data store is accessed for the first time. + + + + Updates data in a data store using the specified modification statements. + + An array of data modification statements. + The result of the data modifications. + + + + When implemented by a class, fetches data from a data store using the specified query statements. + + An array of statements to obtain data from the data store. + Data retrieved from the data store. + + + + When implemented by a class, updates the storage schema according to the specified class descriptions. + + true if the schema should not be created if the table that corresponds to the first item in the tables array doesn’t exist in the data store. + An array of tables whose structure should be saved in the data store. + An value that specifies the result of the update operation. + + + + The interface for objects that need to interact with a data store asynchronously. + + + + + Uses specified modification statements to asynchronously update data in a data store. + + A CancellationToken object that delivers a cancellation notice to the running operation. + An array of data modification statements. + A Task that returns the data modification result. + + + + Uses specified query statements to asynchronously fetch data from a data store. + + A CancellationToken object that delivers a cancellation notice to the running operation. + An array of statements to obtain data from the data store. + A Task that returns data retrieved from the data store. + + + + Represents the insert statement. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the table. + A value that identifies the table. This value is assigned to the JoinNode.Alias property. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the name of an identity column in a table. + + + + + Specifies the type of an identity column in a table. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Returns a string representation of the . + + A string representing the InsertStatement. + + + + Represents the interface for objects that need to interact with SQL Server databases, + + + + + A object that specifies the connection to a data store, if the specified data store allows commands to be created. + + A object that specifies the connection to the data store, if the specified data store allows commands to be created. + + + + Creates a command if the data store allows commands to be created. + + A command that is executed when connected to a data store. + + + + Serves as a base for the class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with default settings. + + A object that represent the table. + A value that identifies the table. This value is assigned to the JoinNode.Alias property. + A enumeration value that specifies the join’s type. This value is assigned to the JoinNode.Type property. + + + + A value that identifies the table. + + + + + Specifies the criteria expression. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Returns the column with the specified name. + + A value that specifies the column’s name. + A object that represents the table column. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Provides access to the collection of sub nodes that is represented by a object. + + + + + Returns a string that represents the current object. + + A that represents the current object. + + + + A enumeration value that specifies the join’s type. + + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Returns a string that represents the current object. + + A that represents the current object. + + + + Lists the values that specify the join type. + + + + + Represents an inner join. Inner joins (also known as equijoins) are used to combine information from two or more tables. + + + + + Includes all the records in which the linked field value in both tables is an exact match and every record in the primary for which there is no match. + + + + + Represents the result of an update operation on a data store. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + An array of identifiers. + + + + + Serves as the base class for classes that represent modification statements. + + + + + Gets the collection of objects. + + + + + Specifies the number of records to be modified. + + + + + Returns a string that represents the current object. + + A that represents the current object. + + + + This class supports the internal infrastructure and is not intended to be used directly from your code. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + For internal use only. + + + + + Represents a query operand. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified column and alias name. + + A object representing the column that the query operand corresponds to. The name of this column is assigned to the QueryOperand.ColumnName property. + A value that specifies the alias name of the table in a query. This value is assigned to the QueryOperand.NodeAlias field. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the column’s name. This value is assigned to the QueryOperand.ColumnName field. + A value that specifies the alias name of the table in a query. This value is assigned to the QueryOperand.NodeAlias field. + + + + Initializes a new instance of the class with the specified column name and alias name. + + A value that specifies the column’s name. This value is assigned to the QueryOperand.ColumnName field. + A value that specifies the alias name of the table in a query. This value is assigned to the QueryOperand.NodeAlias field. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Specifies the column’s name + + + + + The column type. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the alias name of the table in a query. + + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class. + + + + + Initializes and populates a new instance of the class. + + An array of objects that are added to the collection. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Returns a string representation of the . + + A string representing the QueryParameterCollection. + + + + The enumeration describes how connection providers initialize command parameters. + + + + + When Always Encrypted is enabled, the default behavior is the same as SetTypeAndSize, otherwise, providers work in SetType mode. + + + + + A connection provider leaves the , , , and properties unassigned. + + + + + A connection provider initializes only the property. + + + + + A connection provider initializes the , , , and properties. + + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Represents the result of batch select queries made to a data store. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + An array of objects that represent the result of select operations. + + + + The results of select query statements. To learn more, refer to How to: Access Data in SQL Query Results. + + + + + Represents the select statement. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the table. + A value that identifies the table. This value is assigned to the JoinNode.Alias property. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the grouping expression that is represented by a descendant. + + + + + Provides access to the that specifies the columns by which the result of the current should be grouped. + + A that specifies the columns by which the result of the current SelectStatement should be grouped. + + + + Specifies the number of records to exclude from the query result. + + + + + Provides access to the collection. + + A object that represents the collection of objects. + + + + Specifies the maximum number of selected records. + + + + + Returns a string that represents the current object. + + A that represents the current object. + + + + Represents the result of a single select query to a data store. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified collection of rows. + + An array of rows that represent the result of a single select query to a data store. Each row contains the values of the queried fields. This value is assigned to the SelectStatementResult.Rows property. + + + + Initializes a new instance of the class with the specified collection of rows. + + A collection of rows that will be copied to the collection being created. + + + + Initializes a new instance of the class with the specified rows. + + An array of objects that will be represented as the collection’s elements. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + An array of rows that represent the result of a single select query to a data store. Each row contains the values of the queried fields. To learn more, refer to How to: Access Data in SQL Query Results. + + + + + Represents a sorting column in a query. + + + + + Initializes a new class with default settings. + + + + + Initializes a new instance of the class with the specified property and sort direction. + + A descendant representing the query operand that identifies the sorted column in a query. This value is assigned to the SortingColumn.Property property. + A enumeration value which specifies the column’s sort order. This value is assigned to the SortingColumn.Direction property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the name of the sorted column in a query. + A value that specifies the alias name of the table in the query. + A enumeration value which specifies the column’s sort order. This value is assigned to the SortingColumn.Direction property. + + + + Gets or sets the column’s sort order. + + A enumeration value which specifies the column’s sort order. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets or set the query operand that identifies the sorted column in a query. + + A descendant representing the query operand that identifies the sorted column in a query. + + + + Lists the values that specify the sort order. + + + + + A property (column) is sorted in ascending order. + + + + + A property (column) is sorted in descending order. + + + + + Lists the values that specify the result of the data store schema update operation. + + + + + Indicates that the table that corresponds to the first item doesn’t exist in the data store. + + + + + Indicates that the database schema exists. + + + + + Represents the update statement. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the table. + A value that identifies the table. This value is assigned to the JoinNode.Alias property. + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Returns a string representation of the . + + A string representing the UpdateStatement. + + + + An interface for objects that need to accept and execute commands. All XPO layers implement this interface. + + + + + Accepts and executes a specified command with arguments. + + A command to be accepted and executed. + Arguments the command accepts. + An object that is the operation result. + + + + An interface for objects that need to accept and execute commands asynchronously. All XPO layers implement this interface. + + + + + Asynchronously accepts and executes a specified command with arguments. + + A command to be accepted and executed. + Arguments the command accepts. + A CancellationToken object that delivers a cancellation notice to the running operation. + A Task that returns an object. This object is the operation result. + + + + An element in the . + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class. + + A object that represents the expression used to sort values. This value is assigned to the SortProperty.Property property. + A enumeration value which specifies the property’s sort order. This value is assigned to the SortProperty.Direction property. + + + + Initializes a new instance of the class with a property name to sort against and the sort order. + + A value which specifies the name of the property to sort against. This value is assigned to the SortProperty.PropertyName property. + A enumeration value which specifies the property’s sort order. This value is assigned to the SortProperty.Direction property. + + + + Gets or sets the property’s sort order. + + A enumeration value which specifies the property’s sort order. + + + + Gets or sets the expression used to sort values. + + A object that represents the expression used to sort values. + + + + Gets or sets the name of the property to sort against. + + A value which specifies the name of the property that identifies the sorted column in a data store. This value is case-sensitive. + + + + Contains editor classes. They provide the functionality for corresponding controls. + + + + + Contains classes that support the error handling mechanism. + + + + + Encapsulates error information on a specific property. + + + + + Initializes a new instance of the class with the default values. + + + + + Initializes a new instance of the class with the specified error information. + + A string that specifies the error text. This value is used to initialize the ErrorInfo.ErrorText property. + An error type. This value is used to initialize the ErrorInfo.ErrorType property. + + + + Gets or sets the error text associated with the current property name. + + A string that represents the error text. + + + + Gets or sets the type of error associated with the current property name. + + An value that represents the error type. + + + + Enumerates error icon types. + + + + + The ‘Critical Error’ icon: + + + + + The default error icon: + The DXErrorProvider.GetErrorIcon event is not raised when an error of the Default type is assigned to an editor. + + + + + The ‘Information’ icon: + + + + + Indicates that no error is associated with an editor or a cell. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + A user-defined icon to be provided via the DXErrorProvider.GetErrorIcon event. + + + + + The ‘Warning’ icon: + + + + + Provides methods to return error information for a business object’s properties. + + + + + When implemented by a class, this method returns information on an error associated with a business object. + + An object that contains information on an error. + + + + When implemented by a class, this method returns information on an error associated with a specific business object’s property. + + A string that identifies the name of the property for which information on an error is to be returned. + An object that contains information on an error. + + + + Contains values that specify if filters against List properties can be created. + + + + + Allows filters to be created against properties that are List objects. + + + + + Allows filters to be created against properties that are List objects, and against the List’s children. + + + + + Doesn’t allow filters to be created against List properties and against their children. + + + + + Enumerates filters that identify certain dates and date intervals. + + + + + Dates that belong to the month in three months time and beyond. + + + + + Dates that follow the current year. + + + + + Dates that belong to the month seven months ago and earlier. + + + + + Dates of the current month that are prior to the previous week. + + + + + Dates of the current week that are prior to yesterday. + + + + + Dates of the current year that are prior to the current month. + + + + + Does not specify any condition. + + + + + Dates of the previous week. + + + + + Dates of the current month that follow the next week. + + + + + Dates of the current week starting from the day after tomorrow. + + + + + Dates of the current year starting from the following month. + + + + + Dates that belong to the following month. + + + + + Dates that belong to the month in two months time. + + + + + Dates that belong to the previous month. + + + + + Dates that belong to the month two months ago. + + + + + Dates that belong to the month three months ago. + + + + + Dates that belong to the month four months ago. + + + + + Dates that belong to the month five months ago. + + + + + Dates that belong to the month six months ago. + + + + + Dates that belong to the following week. + + + + + Does not specify any condition. + + + + + Dates that are prior to the current year. + + + + + Not supported when setting the FormatConditionRuleDateOccuring.DateType property. + + + + + Dates that belong to the current month. + + + + + Dates that belong to the current week. + + + + + Today. + + + + + Tomorrow. + + + + + Not supported when setting the FormatConditionRuleDateOccuring.DateType property. + + + + + Yesterday. + + + + + If implemented by a class, this interface provides information about a parameter. + + + + + If implemented by a class, this property returns the parameter name. + + The parameter name. + + + + If implemented by a class, this property returns the parameter type. + + The parameter type. + + + + The interface that a Range Control Client must implement to be embedded in Range Control ( or ). + + + + + This method is fired when the RangeControl’s state, size or settings are changed. + + A Rectangle that specifies the bounds of the Range Control’s viewport. + + + + When implemented by a class, this method allows you to provide custom selection bounds. + + Provides data used to paint the selection. + Specifies the selected region’s bounds. + Returns custom bounds of the selected region. + + + + Renders the Range Control’s viewport. + + A RangeControlPaintEventArgs value that contains data to paint the viewport. + + + + This method allows you to manually draw the ruler. It returns a value indicating whether the ruler has been drawn. + + A RangeControlPaintEventArgs value that contains data to paint the ruler. + true if the Client draws the ruler itself; false if the ruler is painted by the Range Control. + + + + When implemented by a class, this method custom draws the selected region. + + Provides data to custom paint the selected region. + + + + Converts a ruler’s regular value (between the total range’s Minimum and Maximum) into a normalized value (between 0 and 1). + + A ruler’s regular value (between the total range’s Minimum and Maximum) + A ruler’s normalized value (between 0 and 1). + + + + The method should return an object that exposes the Client’s customization options for the Range Control. + + An object that exposes the Client’s customization options for the Range Control. + + + + This method should return custom ruler values if these values are not equally spaced. + + A RulerInfoArgs object that contains the ruler related information. + A list of ruler values; null if the ruler has equally spaced increments specified by the IRangeControlClient.RulerDelta property. + + + + Converts a ruler’s normalized value (between 0 and 1) into a regular value (between the total range’s Minimum and Maximum). + + A ruler’s normalized value (between 0 and 1). + A ruler’s regular value (between the total range’s Minimum and Maximum). + + + + This property should specify the description of the Client’s current invalid state. + + A string that is the description of the Client’s current invalid state. + + + + This property should return a value indicating whether the Range Control must reserve space to paint the ruler. + + true if the Range Control must not reserve space to paint the ruler; otherwise, false. + + + + This property should indicate whether the Client’s state is valid and the Client should render itself within the viewport. + + true if the Client’s state is valid and the Client should render itself within the viewport; false if the IRangeControlClient.InvalidText message should be painted within the viewport. + + + + This method indicates whether the specified type of ruler values is supported. + + The type of ruler values being checked. + true if the specified type is supported; otherwise, false. + + + + This property should return the normalized distance between the ruler’s adjacent tickmarks. + + An object that identifies the normalized distance between the ruler’s adjacent tickmarks. + + + + This method is called when an end-user clicks within the Range Control’s viewport. + + A RangeControlHitInfo object that allows you to identify the clicked element. + + + + This method is called by the Range Control to notify the Client that the range has been changed. + + The minimum value of the new range. + The maximum value of the new range. + + + + This method is fired when the client is attached to a new Range Control. + + The new range control. + + + + This method is called when the Range Control’s size is changed. + + + + + This property returns the bottom indent of the selection area within the viewport. + + The bottom indent of the selection area within the viewport. + + + + This property returns the top indent of the selection area within the viewport. + + The top indent of the selection area within the viewport. + + + + This event must fire when the Client’s range setting is changed. + + + + + This property returns the distance between the ruler’s adjacent tickmarks. + + An object that identifies the distance between the ruler’s adjacent tickmarks. + + + + Returns the text representation of ruler values + + The zero-based index of a specific ruler value. + A string that is the text representation of the specified ruler value. + + + + This method checks whether the client control that accepts a DevExpress Range Control supports the given Range Control orientation. + + An orientation to check. + true, if the client control supports this Range Control orientation; otherwise, false. + + + + This method is fired when you move the mouse cursor over the viewport. + + A RangeControlHitInfo object that contains information on the point being hovered over. + + + + This method is fired when you press the mouse button within the viewport (without releasing the mouse button). + + A RangeControlHitInfo object that contains information on the point being pressed. + + + + Validates a range when it is changed. + + A NormalizedRangeInfo object that contains information on the current range. + + + + Validates a scale(zoom) factor. + + A double value that is the new scale factor that is about to be applied. + The valid scale factor. + + + + Returns the text representation of normalized values. + + The currently processed normalized value (between 0 and 1). + The text representation of the current value. + + + + Contains information on a range of data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified range bounds. + + The value to initialize the RangeControlRange.Minimum property. + The value to initialize the RangeControlRange.Maximum property. + + + + Gets or sets the end bound of a range. + + The end bound of a range. + + + + Gets or sets the start bound of a range. + + The start bound of a range. + + + + Contains classes that provide information about the grid control, grid levels and implement the functionality for summaries, styles and style conditions. + + + + + Contains values that specify how a column’s data is filtered via the auto filter row and filter dropdown. + + + + + A column’s data is filtered by the display text. + + + + + A column’s data is filtered by the edit values. + + + + + Lists the values that specify how the data rows are combined into groups when in grouping mode. + + + + + Rows are grouped by the character that grouping column values start with. + + + + + + + This option is in effect only for columns that store date/time values. + + Rows are grouped by the date part of their values, the time portion is ignored in this grouping mode. + + + + + This option is in effect only for columns that store date/time values. + + Rows are grouped by the month part of their values. + + + + + This option is in effect for columns that store date/time values. Rows are combined into the following non-overlapping groups according to their date value as compared with today’s date: + “Beyond Next Month”, + “Next Month”, + “Later this Month”, + “Three Weeks Away”, + “Two Weeks Away”, + “Next Week”, + “Today”, + “Tomorrow”, + “Yesterday”, + “Sunday”, + “Monday”, + “Tuesday”, + “Wednesday”, + “Thursday”, + “Friday”, + “Saturday”, + “Last Week”, + “Two Weeks Ago”, + “Three Weeks Ago”, + “Earlier this Month”, + “Last Month”, + “Older”. + + + + + This option is in effect only for columns that store date/time values. + + Rows are grouped by the year part of their values. + + + + + For columns which store date/time values, this option is the same as the ColumnGroupInterval.Date option. For non date/time columns this option is the same as the ColumnGroupInterval.Value option. + + + + + Rows are grouped by display values of the grouping column. + In specific instances, column cells can have different edit values, but the same display value. To combine these rows into the same group, use the DisplayText group mode. + + + + + + + Rows are grouped by values of grouping columns. The number of groups matches the number of unique values within the grouping column. + For date/time columns, both the date and time portions are taken into account for value comparison. To specify how date/time values are presented in group rows in WinForms Data Grid, apply formatting to the grouping column (e.g., with the GridColumn.DisplayFormat property). + + + + + Lists the values that specify how a column’s data should be sorted. + + + + + Applies sort options specified in the CustomColumnSort event handler. + In data grids, this mode also applies group options from the CustomColumnGroup event handler. + + + + + The actual sort mode is determined by a control. See the property description for more details. + + + + + Sorts the column’s data by the column’s display text (the strings displayed within the column’s cells). + + + + + Sorts the column’s data by the column’s edit values (these are synchronized with the bound data source’s values). + + + + + Contains classes that provide the basic functionality for the XtraPrinting library (bricks, pages, document). + + + + + Lists the values used to specify the border’s dash style for an . + + + + + Specifies a line consisting of dashes. + + + + + Specifies a line consisting of a repeating dash-dot pattern. Not supported in HTML (becomes visible as Dash) + + + + + Specifies a line consisting of a repeating dash-dot-dot pattern. Not supported in HTML (becomes visible as Dash) + + + + + Specifies a line consisting of dots. + + + + + Specifies a double solid line. + + + + + Specifies a solid line. + + + + + Specifies the borders displayed around a brick. + + + + + Applies all borders to a brick. + + + + + Applies the bottom border to a brick. + + + + + Applies the left border to a brick. + + + + + No borders are applied to a brick. + + + + + Applies the right border to a brick. + + + + + Applies the top border to a brick. + + + + + Specifies brick alignment relative to its layout rectangle. + + + + + Specifies whether a brick is aligned by the center of the layout rectangle. + + + + + Specifies whether a brick is aligned away from the original position of the layout rectangle. + + + + + Specifies that the text shall be aligned near the layout. In a left-to-right layout, the near position is left. In a right-to-left layout, the near position is right. + + + + + Cancels brick alignment. + + + + + Specifies the border style for a brick. + + + + + The borders are drawn over the contour of the brick’s rectangle, so that they are partially inside and outside of the brick. + + + + + The borders are drawn inside the brick’s rectangle. + + + + + The borders are drawn outside the brick’s rectangle. + + + + + Provides data for the BeforeChange and AfterChange events of the class and the interface. + + + + + Initializes a new instance of the class and sets its ChangeEventArgs.EventName property to a specified value. + + A value, specifying the event name. + + + + Initializes a new instance of the DevExpress.XtraPrinting.ChangeEventArgs.EventInfo class with the specified name and value and adds it to the collection. + + A specifying the event’s name. + An specifying the value of the DevExpress.XtraPrinting.ChangeEventArgs.EventInfo object. + + + + Gets the event name that initiated a ChangeEvent. + + The event name that initiated a ChangeEvent. + + + + Returns an object, containing information about the event with the specified name. + + A specifying the event name. + A DevExpress.XtraPrinting.ChangeEventArgs.EventInfo object with the specified name. + + + + A method that will handle the BeforeChange and AfterChange events of the class and the interface. + + The event source. + A object that contains data related to the event. + + + + Specifies the visual state of a check box. + + + + + The check box is checked. + + + + + A visual state that signals to the user that the control state cannot be determined. + + + + + The check box is unchecked. + + + + + Lists the available export formats. + + + + + The document is exported in the CSV format. + + + + + The document is exported in the DOCX format. + + + + + The document is exported in the HTML format. + + + + + The document is exported in an image format. + + + + + The document is exported in the MHT format. + + + + + The document is exported in the PDF format. + + + + + The document is exported in the RTF format. + + + + + The document is exported in the text format. + + + + + The document is exported in the XLS format. + + + + + The document is exported in the XLSX format. + + + + + Enables you to calculate the DPI values associated with specific units of measure (and vice versa). + + + + + Initializes a new instance of the class with the default settings. + + + + + 96f + + + + + 75f + + + + + 300f + + + + + Converts the specified DPI value to a corresponding unit of measure. + + A value. + A enumeration value. + + + + 914400f + + + + + Gets the DPI value corresponding to the unit of measure of the specified Graphics object. + + A object. + A value. + + + + 100f + + + + + 1f + + + + + 25.4f + + + + + 96f + + + + + 72f + + + + + 254f + + + + + 1440f + + + + + Converts the specified unit of measure to a corresponding DPI value. + + A enumeration value. + A value. + + + + Converts the specified unit of measure to a corresponding DPI value. + + A enumeration value. + A value. + + + + Returns a string value, identifying the specified unit of measure. + + A enumeration value. + A value. + + + + Enables you to convert values that are calculated in some measure units to different measure units. + + + + + Initializes a new instance of the class with the default settings. + + + + + Adjusts the document margins calculated for the specified unit of measure according to a new unit of measure. + + A DevExpress.XtraPrinting.Native.MarginsF object. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A DevExpress.XtraPrinting.Native.MarginsF object. + + + + Adjusts the document margins calculated for the specified DPI according to a new DPI. + + A DevExpress.XtraPrinting.Native.MarginsF object. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A DevExpress.XtraPrinting.Native.MarginsF object. + + + + Adjusts the location and size of a rectangle calculated for the specified unit of measure according to a new unit of measure. + + A DevExpress.XtraPrinting.Native.RectangleDF structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A DevExpress.XtraPrinting.Native.RectangleDF structure. + + + + Adjusts the location and size of a rectangle calculated for the specified DPI according to a new DPI. + + A DevExpress.XtraPrinting.Native.RectangleDF structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A DevExpress.XtraPrinting.Native.RectangleDF structure. + + + + Adjusts the coordinates of a point calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the coordinates of a point calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the coordinates of a point calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the coordinates of a point calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the document margins calculated for the specified DPI according to a new DPI. + + A object. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A object. + + + + Adjusts the location and size of a rectangle calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the location and size of a rectangle calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the location and size of a rectangle calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the location and size of a rectangle calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the size calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the size calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the size calculated for the specified unit of measure according to a new unit of measure. + + A structure. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A structure. + + + + Adjusts the size calculated for the specified DPI according to a new DPI. + + A structure. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the integer value calculated for the specified DPI according to a new DPI. + + An integer value. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + An integer value. + + + + Adjusts the floating-point value calculated for the specified unit of measure according to a new unit of measure. + + A value. + A enumeration value, specifying the initial unit of measure. + A enumeration value, specifying the required unit of measure. + A value. + + + + Adjusts the floating-point value calculated for the specified DPI according to a new DPI. + + A value. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A value. + + + + Converts the location and size of a rectangle calculated in device-independent pixels (DIP) to a value calculated in document units (measured in 1/300 of an inch). + + A structure. + A structure. + + + + Converts the size calculated in device-independent pixels (DIP) to a size calculated in document units (measured in 1/300 of an inch). + + A structure. + A structure. + + + + Converts the floating-point value calculated in device-independent pixels (DIP) to a value calculated in document units (measured in 1/300 of an inch). + + A value. + A value. + + + + Converts the location and size of a rectangle calculated in document units (measured in 1/300 of an inch) to a value calculated in device-independent pixels (DIP). + + A structure. + A structure. + + + + Converts the floating-point value calculated in document units (measured in 1/300 of an inch) to a value calculated in device-independent pixels (DIP). + + A value. + A value. + + + + Converts the document margins calculated in document units (measured in 1/300 of an inch) to a value calculated in pixels. + + A DevExpress.XtraPrinting.Native.MarginsF object. + A DevExpress.XtraPrinting.Native.MarginsF object. + + + + Converts the coordinates of a point calculated in document units (measured in 1/300 of an inch) to a value calculated in pixels. + + A structure. + A structure. + + + + Converts the location and size of a rectangle calculated in document units (measured in 1/300 of an inch) to a value calculated in pixels. + + A structure. + A structure. + + + + Converts the size calculated in document units (measured in 1/300 of an inch) to a size calculated in pixels. + + A structure. + A structure. + + + + Converts the floating-point value calculated in document units (measured in 1/300 of an inch) to a value calculated in pixels. + + A value. + A value. + + + + Converts the coordinates of a point calculated in pixels to a value calculated in document units (measured in 1/300 of an inch). + + A structure. + A structure. + + + + Converts the location and size of a rectangle calculated in pixels to a value calculated in document units (measured in 1/300 of an inch). + + A structure. + A structure. + + + + Converts the size calculated in pixels to a size calculated in document units (measured in 1/300 of an inch). + + A structure. + A structure. + + + + Converts the floating-point value calculated in pixels to a value calculated in document units (measured in 1/300 of an inch). + + A value. + A value. + + + + Adjusts the floating-point coordinates of a point to the nearest integer values. + + A structure. + A structure. + + + + Adjusts the floating-point dimensions of a rectangle to the nearest integer values. + + A structure. + A structure. + + + + Lists the available horizontal content splitting modes. + + + + + When the brick dimensions do not fit into the bottom page margin, the rest of the brick content is split across two pages. + + + + + When the brick dimensions do not fit into the bottom page margin, the brick content is moved to a new page in its entirety. + + + + + Provides the basic functionality to draw visual bricks and specify their properties. + + + + + Obtains the Hashtable collection of properties for the class that implements the interface. + + A Hashtable object that contains properties of the class that implements the interface. + + + + Sets property values for the class which implements the interface + based on the specified Hashtable object. + + Identifies the Hashtable collection of property names and values that must be set. + + + + Sets property values for the class which implements the interface based on the specified properties array. + + A two-dimesional array that identifies property names and values to set. + + + + Specifies the alignment of a displayed image in relation to the container control’s boundaries. + + + + + An image is aligned to the bottom side of a control. + + + + + An image is aligned to the bottom left corner of a control. + + + + + An image is aligned to the bottom right corner of a control. + + + + + The default image alignment is used. + + + + + An image is aligned to the middle of a control. + + + + + An image is aligned to the left side of a control. + + + + + An image is aligned to the right side of a control. + + + + + An image is aligned to the top side of a control. + + + + + An image is aligned to the top left corner of a control. + + + + + An image is aligned to the top right corner of a control. + + + + + Specifies how an image is positioned within a Picture Box. + + + + + + The Picture Box size is adjusted to that of the image it contains. + + + + + This option is obsolete. To achieve the same result, set the XRPictureBox.Sizing property of a Picture Box to ImageSizeMode.Normal and the XRPictureBox.ImageAlignment property to ImageAlignment.MiddleCenter. + + + + + + The image is sized proportionally, so that it fits the Picture Box control’s entire area. If the height-to-width ratio of the control and the image are equal, the image is resized to exactly fit into the control’s dimensions. Otherwise, the least matching image side (height or width) is sized to the control, the other side is sized proportionally. The resulting image is centered as the control’s property specifies. Image parts that do not fit the control are clipped. + + + + + + The image is placed in the upper-left corner of the Picture Box. The image is clipped if it does not fit into the control’s bounds. + + + + + + If the Picture Box dimensions exceed that of the image it contains, the image is centered and shown full-size. Otherwise, the image is resized to fit into the control’s dimensions. + + + + + + The image is stretched or shrunk to fit into the current Picture Box dimensions. + + + + + + The image is replicated within the Picture Box starting from the upper-left corner. The image is clipped if it does not fit into the control’s dimensions. + + + + + + + The image is sized proportionally (without clipping), so that it fits best within the Picture Box dimensions. If the height-to-width ratio of the control and the image are equal, the image will be resized to exactly fit into the control’s dimensions. + Otherwise, the closest matching image side (height or width) will be sized to the control, and the other side will be sized proportionally (possibly leaving empty space within the control). + + + + + Contains classes and enumerations that are intended to localize the User Interface of the XtraPrinting Library. + + + + + A base class that provides necessary functionality for custom localizers of the Printing-Exporting Library. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies a localizer object providing localization of the XtraPrinting Library interface at runtime. + + An descendant, used to localize the user interface at runtime. + + + + Returns a Localizer object storing resources based on the thread’s language and regional settings (culture). + + An object, storing resources based on the thread’s language and regional settings (culture). + + + + For internal use. Returns a Localizer object storing resources based on the thread’s language and regional settings (culture). + + An object, storing resources based on the thread’s language and regional settings (culture). + + + + Returns a localized string for the given string identifier. + + A enumeration value, identifying the string to localize. + A value, corresponding to the specified identifier. + + + + A default localizer to translate the XtraPrinting’s resources. + + + + + Initializes a new instance of the class with the default settings. + + + + + Contains values corresponding to strings that can be localized for the print preview. + + + + + “Barcode“ + + + + + “Character Comb“ + + + + + “Chart“ + + + + + “0}. State {1}“ + + + + + “Checkbox“ + + + + + “Gauge“ + + + + + “Image“ + + + + + “Line“ + + + + + “Page info“ + + + + + “Progress bar“ + + + + + “Shape“ + + + + + “Sparkline“ + + + + + “Zip Code“ + + + + + “Main Menu“ + + + + + “Status Bar“ + + + + + “Toolbar“ + + + + + “Apply“ + + + + + “Cancel“ + + + + + “Help“ + + + + + “OK“ + + + + + “Current Month“ + + + + + “Current Quarter“ + + + + + “Current Week“ + + + + + “Current Year“ + + + + + “Last 7 Days“ + + + + + “Last Month“ + + + + + “Last Week“ + + + + + “Last Year“ + + + + + “Previous Month“ + + + + + “Previous Quarter“ + + + + + “Previous Week“ + + + + + “Previous Year“ + + + + + “Today“ + + + + + “Yesterday“ + + + + + “Date-Time“ + + + + + “Letters“ + + + + + “Numeric“ + + + + + “Date“ + + + + + “Fixed-Point“ + + + + + “Fixed-Point Positive“ + + + + + “Image“ + + + + + “Image and Signature“ + + + + + “Integer“ + + + + + “Integer Positive“ + + + + + “Only Latin Letters“ + + + + + “Only Letters“ + + + + + “Only Lowercase Letters“ + + + + + “Only Uppercase Letters“ + + + + + “Signature“ + + + + + “From“ + + + + + “Confirmation password does not match. Please start over and enter the password again.“ + + + + + “Confirm Document Open Password“ + + + + + “Document Open Pa&ssword:“ + + + + + “Please confirm the Document Open Password. Be sure to make a note of the password. It will be required to open the document.“ + + + + + “Confirm Permissions Password“ + + + + + “&Permissions Password:“ + + + + + “Please confirm the Permissions Password. Be sure to make a note of the password. You will need it to change these settings in the future.“ + + + + + “(Using System Separator)“ + + + + + “Export mode:“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Export watermarks“ + + + + + “Keep row height“ + + + + + “Page range:“ + + + + + “Table layout“ + + + + + “Character set:“ + + + + + “Embed images in HTML“ + + + + + “Export mode:“ + + + + + “Different files“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Export watermarks“ + + + + + “Page border color:“ + + + + + “Page border width:“ + + + + + “Page range:“ + + + + + “Remove carriage returns“ + + + + + “Table layout“ + + + + + “Title:“ + + + + + “Export mode:“ + + + + + “Different files“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Image format:“ + + + + + “Page border color:“ + + + + + “Page border width:“ + + + + + “Page range:“ + + + + + “Resolution (dpi):“ + + + + + “Compressed“ + + + + + “PDF/A Compatibility:“ + + + + + “None“ + + + + + “PDF/A-1a“ + + + + + “PDF/A-1b“ + + + + + “PDF/A-2a“ + + + + + “PDF/A-2b“ + + + + + “PDF/A-3a“ + + + + + “PDF/A-3b“ + + + + + “Any except extracting pages“ + + + + + “Commenting, filling in form fields, and signing existing signature fields“ + + + + + “Filling in form fields and signing existing signature fields“ + + + + + “Inserting, deleting and rotating pages“ + + + + + “None“ + + + + + “Convert Images to Jpeg“ + + + + + “Application:“ + + + + + “Author:“ + + + + + “Keywords:“ + + + + + “Subject:“ + + + + + “Title:“ + + + + + “Export editing fields to AcroForms“ + + + + + “Images quality:“ + + + + + “High“ + + + + + “Highest“ + + + + + “Low“ + + + + + “Lowest“ + + + + + “Medium“ + + + + + “Don’t embed these fonts:“ + + + + + “Page range:“ + + + + + “Password Security:“ + + + + + “Document Open Password“ + + + + + “(none)“ + + + + + “Permissions“ + + + + + “High Resolution“ + + + + + “Low Resolution (150 dpi)“ + + + + + “None“ + + + + + “Show print dialog on open“ + + + + + “None“ + + + + + “Issuer:“ + + + + + “Valid From: {0:d} to {1:d}“ + + + + + “Digital Signature:“ + + + + + “Certificate“ + + + + + “Contact Info“ + + + + + “Image“ + + + + + “Location“ + + + + + “(none)“ + + + + + “Reason“ + + + + + “PDF/UA compatibility:“ + + + + + “None“ + + + + + “PDF/UA-1“ + + + + + “Export mode:“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Export watermarks“ + + + + + “Page range:“ + + + + + “Encoding:“ + + + + + “Text export mode:“ + + + + + “Text“ + + + + + “Value“ + + + + + “Quote strings with separators“ + + + + + “Text separator:“ + + + + + “TAB“ + + + + + “Export hyperlinks“ + + + + + “Export mode:“ + + + + + “Different files“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Page range:“ + + + + + “Raw data mode“ + + + + + “Sheet name:“ + + + + + “Show grid lines“ + + + + + “Export mode:“ + + + + + “Different files“ + + + + + “Single file“ + + + + + “Single file page-by-page“ + + + + + “Page range:“ + + + + + “Compression:“ + + + + + “Fast“ + + + + + “Maximum“ + + + + + “Normal“ + + + + + “Not compressed“ + + + + + “Super fast“ + + + + + “Category:“ + + + + + “Creator:“ + + + + + “Description:“ + + + + + “Keywords:“ + + + + + “Subject:“ + + + + + “Title:“ + + + + + “Version:“ + + + + + “Page range:“ + + + + + “CSV Export Options“ + + + + + “DOCX Export Options“ + + + + + “HTML Export Options“ + + + + + “Image Export Options“ + + + + + “MHT Export Options“ + + + + + “Native Format Options“ + + + + + “PDF Export Options“ + + + + + “RTF Export Options“ + + + + + “Text Export Options“ + + + + + “XLS Export Options“ + + + + + “XLSX Export Options“ + + + + + “XPS Export Options“ + + + + + “Select a folder to save the exported document to:“ + + + + + “Alignment“ + + + + + “Brush Color“ + + + + + “Brush Options“ + + + + + “Brush Size“ + + + + + “Choose Image“ + + + + + “Clear“ + + + + + “Load Image“ + + + + + “Reset“ + + + + + “Size Mode“ + + + + + “Size Mode And Alignment“ + + + + + “Bottom Margin“ + + + + + “Inch“ + + + + + “Left Margin“ + + + + + “mm“ + + + + + “px“ + + + + + ““Right Margin““ + + + + + “Top Margin“ + + + + + “&Color…“ + + + + + “&Background“ + + + + + “Copy“ + + + + + “CSV File“ + + + + + “DOCX File“ + + + + + “E&xit“ + + + + + “&Export To“ + + + + + “&File“ + + + + + “Image File“ + + + + + “HTML File“ + + + + + “MHT File“ + + + + + “&Page Layout“ + + + + + “Page Set&up…“ + + + + + “PDF File“ + + + + + “&Print…“ + + + + + “P&rint“ + + + + + “Print…“ + + + + + “RTF File“ + + + + + “Sen&d As“ + + + + + “Text File“ + + + + + “&View“ + + + + + “&Continuous“ + + + + + “&Facing“ + + + + + “&Statusbar“ + + + + + “&Toolbar“ + + + + + “&Watermark…“ + + + + + “XLS File“ + + + + + “XLSX File“ + + + + + “Page Width“ + + + + + “Text Width“ + + + + + “Two Pages“ + + + + + “Whole Page“ + + + + + “Pages“ + + + + + “The output file is too big. Please try to reduce the image resolution,\r\nor choose another export mode.“ + + + + + “The output file is too big. Try to reduce the number of its pages, or split it into several documents.“ + + + + + “The output file is too big to create a JPEG file. Please choose another image format or another export mode.“ + + + + + “The process cannot access the file "{0}" because it is being used by another process.“ + + + + + “**The document cannot be exported to DOCX format correctly with the specified settings.rn + If possible, avoid intersecting elements in your document, or try to use the ‘{0}’ export mode with the ‘{1}’ option disabled.**” + + + + + “Cannot perform the specified task. The following library is missing: "{0}"“ + + + + + “The specified file cannot be loaded, because it either does not contain valid XML data or exceeds the allowed size.“ + + + + + “Control’s boundaries are too small for the barcode“ + + + + + “Printing“ + + + + + “Creating the document…“ + + + + + “Warning!“ + + + + + “The document does not contain any pages.“ + + + + + “Page margins are greater than page size.“ + + + + + “The data you entered do not match the parameter type.“ + + + + + “Error” + + + + + “Exporting the document…“ + + + + + “The output file already exists. Click OK to overwrite.“ + + + + + “The specified file doesn’t contain valid XML data in the PRNX format. Loading is stopped.“ + + + + + “The specified file doesn’t have a PRNX extension. Proceed anyway?“ + + + + + “File "{0}" is set to read-only, try again with a different file name.“ + + + + + “The font size cannot be set to zero or a negative number“ + + + + + “There is no page numbered {0} in this document.“ + + + + + “**Some SVG elements in this image are unsupported and will be ignored. + Please modify the image to avoid these element types: {0}.**” + + + + + “Cannot load the image from the specified file.“ + + + + + “Incompatible settings : {0}“ + + + + + “Logo size / Module / Error correction level“ + + + + + “This is not a valid page range“ + + + + + “The number must be between {0} and {1}.“ + + + + + “Cannot find the specified path.“ + + + + + "Text can only contain an even number of characters." + + + + + “Binary data can’t be longer than 1033 bytes.“ + + + + + "Text value cannot be empty." + + + + + "CharsetC cannot contain FNC2/FNC3/FNC4 symbols." + + + + + "Text must contain only numbers." + + + + + "Data contains invalid characters {0}." + + + + + “There are invalid characters in the text“ + + + + + “Invalid text format“ + + + + + "Text should have {0} characters." + + + + + “This is not a valid measurement.“ + + + + + “Invalid property name“ + + + + + “No printers installed.“ + + + + + “A document can’t be exported to a stream in the DifferentFiles mode. Use the SingleFile or SingleFilePageByPage mode instead.“ + + + + + “The specified parameters does not exist: {0}.“ + + + + + “This font is not yet supported“ + + + + + “The "{0}" cannot be used since this could be an unsupported OpenType font.“ + + + + + “Do you want to open this file?“ + + + + + “Export“ + + + + + “One or more margins are set outside the printable area of the page. Continue?“ + + + + + “The path is too long.\r\nTry a shorter name.“ + + + + + “Cannot load the PDF content from the specified file.“ + + + + + “Creating“ + + + + + “Exporting“ + + + + + “Printing“ + + + + + “Search“ + + + + + “The separator cannot be an empty string.“ + + + + + “The net printer is unavailable.“ + + + + + “Waiting for parameter values…“ + + + + + “The current printer doesn’t support the selected paper size.\r\nProceed with printing anyway?“ + + + + + “The printer name is invalid. Please check the printer settings.“ + + + + + “An error occurred during printing a document.“ + + + + + “The created XLS file is too big for the XLS format, because it contains more than 256 columns.\r\nPlease try to use the XLSX format, instead.“ + + + + + “The created XLS file is too big for the XLS format, because it contains more than 65,536 rows.\r\nPlease try to use the XLSX format, instead.“ + + + + + “The created XLSX file is too big for the XLSX format, because it contains more than 16,384 columns.\r\nPlease try to reduce the amount of columns in your report and export the report to XLSX again.“ + + + + + “The created XLSX file is too big for the XLSX format, because it contains more than 1,048,576 rows.\r\nPlease try to reduce the amount of rows in your report and export the report to XLSX again.“ + + + + + “{0} on {1}“ + + + + + “(none)“ + + + + + “Preview Document Files (*{0})|*{0}|All Files (*.*)|*.*“ + + + + + “Open“ + + + + + “[Date Printed]“ + + + + + “[Page #]“ + + + + + “[Page # of Pages #]“ + + + + + “[Time Printed]“ + + + + + “[Pages #]“ + + + + + “[User Name]“ + + + + + “No Look-Up“ + + + + + “No Range“ + + + + + “{0} selected (All)“ + + + + + “Parameters“ + + + + + “(none)“ + + + + + “Reset“ + + + + + “{0} selected“ + + + + + “Submit“ + + + + + “Preview“ + + + + + “Flip on Short Edge“ + + + + + “None“ + + + + + “Flip on Long Edge“ + + + + + “The printer is busy.“ + + + + + “The printer door is open.“ + + + + + “The printer driver needs to be updated.“ + + + + + “Error“ + + + + + “Initializing the Preview…“ + + + + + “The printer’s input/output is active.“ + + + + + “The manual feed is enabled.“ + + + + + “The printer is not available.“ + + + + + “The printer has no toner.“ + + + + + “The printer is offline.“ + + + + + “The printer is out of memory.“ + + + + + “The output bin is full.“ + + + + + “A page punt has occurred.“ + + + + + “The paper has jammed.“ + + + + + “The printer is out of paper.“ + + + + + “A paper-related problem has occurred.“ + + + + + “The printer is paused.“ + + + + + “Print task deletion is pending.“ + + + + + “The power save mode is on.“ + + + + + “Printing…“ + + + + + “Processing…“ + + + + + “The printer is ready.“ + + + + + “The server is offline.“ + + + + + “The server is unknown.“ + + + + + “The toner is low.“ + + + + + “A user intervention has occurred.“ + + + + + “Waiting…“ + + + + + “The printer is warming up.“ + + + + + “Close Print Preview“ + + + + + “Close Print Preview of the document.“ + + + + + “Close Print Preview“ + + + + + “Options“ + + + + + “Open the Print Options dialog, in which you can change printing options.“ + + + + + “Options“ + + + + + “Bookmarks“ + + + + + “Open the Document Map, which allows you to navigate through a structural view of the document.“ + + + + + “Document Map“ + + + + + “Header/Footer“ + + + + + “Edit the header and footer of the document.“ + + + + + “Header and Footer“ + + + + + “CSV File“ + + + + + “Comma-Separated Values Text“ + + + + + “Export the document to CSV and save it to the file on a disk.“ + + + + + “Export to CSV“ + + + + + “DOCX File“ + + + + + “Microsoft Word 2007 Document“ + + + + + “Export the document to DOCX and save it to the file on a disk.“ + + + + + “Export to DOCX“ + + + + + “Export To“ + + + + + “Export the current document in one of the available formats, and save it to the file on a disk.“ + + + + + “Export To…“ + + + + + “Image File“ + + + + + “BMP, GIF, JPEG, PNG, TIFF, EMF, WMF“ + + + + + “Export the document to Image and save it to the file on a disk.“ + + + + + “Export to Image“ + + + + + “HTML File“ + + + + + “Web Page“ + + + + + “Export the document to HTML and save it to the file on a disk.“ + + + + + “Export to HTML“ + + + + + “MHT File“ + + + + + “Single File Web Page“ + + + + + “Export the document to MHT and save it to the file on a disk.“ + + + + + “Export to MHT“ + + + + + “PDF File“ + + + + + “Adobe Portable Document Format“ + + + + + “Export the document to PDF and save it to the file on a disk.“ + + + + + “Export to PDF“ + + + + + “RTF File“ + + + + + “Rich Text Format“ + + + + + “Export the document to RTF and save it to the file on a disk.“ + + + + + “Export to RTF“ + + + + + “Text File“ + + + + + “Plain Text“ + + + + + “Export the document to Text and save it to the file on a disk.“ + + + + + “Export to Text“ + + + + + “XLS File“ + + + + + “Microsoft Excel 2000-2003 Workbook“ + + + + + “Export the document to XLS and save it to the file on a disk.“ + + + + + “Export to XLS“ + + + + + “XLSX File“ + + + + + “Microsoft Excel 2007 Workbook“ + + + + + “Export the document to XLSX and save it to the file on a disk.“ + + + + + “Export to XLSX“ + + + + + “XPS File“ + + + + + “XPS“ + + + + + “Page Color“ + + + + + “Choose a color for the background of the document pages.“ + + + + + “Background Color“ + + + + + “Find“ + + + + + “Show the Find dialog to find text in the document.“ + + + + + “Find“ + + + + + “Top:\t\t{0}\t\tBottom:\t\t{1}\r\nLeft:\t\t {2}\t\tRight:\t\t {3}“ + + + + + “Moderate“ + + + + + “Moderate“ + + + + + “Narrow“ + + + + + “Narrow“ + + + + + “Normal“ + + + + + “Normal“ + + + + + “Wide“ + + + + + “Wide“ + + + + + “Landscape“ + + + + + “” + + + + + “Portrait“ + + + + + “” + + + + + “{0} x {1}“ + + + + + “Hand Tool“ + + + + + “Invoke the Hand tool to manually scroll through pages.“ + + + + + “Hand Tool“ + + + + + “Editing Fields“ + + + + + “Highlight all editing fields to quickly discover which of the document elements are editable.“ + + + + + “Highlight Editing Fields“ + + + + + “Magnifier“ + + + + + “Invoke the Magnifier tool.\r\n\r\nClicking once on a document zooms it so that a single page becomes entirely visible, while clicking another time zooms it to 100% of the normal size.“ + + + + + “Magnifier“ + + + + + “Many Pages“ + + + + + “Choose the page layout to arrange the document pages in preview.“ + + + + + “View Many Pages“ + + + + + “Open“ + + + + + “Open a document.“ + + + + + “Open (Ctrl + O)“ + + + + + “Page Background“ + + + + + “Close“ + + + + + “Document“ + + + + + “Export“ + + + + + “Navigation“ + + + + + “Page Setup“ + + + + + “Show the Page Setup dialog.“ + + + + + “Page Setup“ + + + + + “Print“ + + + + + “Zoom“ + + + + + “Margins“ + + + + + “Select the margin sizes for the entire document.\r\n\r\nTo apply specific margin sizes to the document, click Custom Margins.“ + + + + + “Page Margins“ + + + + + “Orientation“ + + + + + “Switch the pages between portrait and landscape layouts.“ + + + + + “Page Orientation“ + + + + + “Custom Margins…“ + + + + + “Show the Page Setup dialog.“ + + + + + “Page Setup‘ + + + + + “Print Preview“ + + + + + “Size“ + + + + + “Choose the paper size of the document.“ + + + + + “Page Size“ + + + + + “Parameters“ + + + + + “Open the Parameters pane, which allows you to enter values for report parameters.“ + + + + + “Parameters“ + + + + + “Pointer“ + + + + + “Show the mouse pointer.“ + + + + + “Mouse Pointer“ + + + + + “Print“ + + + + + “Select a printer, number of copies and other printing options before printing.“ + + + + + “Print (Ctrl+P)“ + + + + + “Quick Print“ + + + + + “Send the document directly to the default printer without making changes.“ + + + + + “Quick Print“ + + + + + “Save“ + + + + + “Save the document.“ + + + + + “Save (Ctrl + S)“ + + + + + “Scale“ + + + + + “Stretch or shrink the printed output to a percentage of its actual size.“ + + + + + “Scale“ + + + + + “CSV File“ + + + + + “Comma-Separated Values Text“ + + + + + “Export the document to CSV and attach it to the e-mail.“ + + + + + “E-Mail As CSV“ + + + + + “DOCX File“ + + + + + “Microsoft Word 2007 Document“ + + + + + “Export the document to DOCX and attach it to the e-mail.“ + + + + + “E-Mail As DOCX“ + + + + + “E-Mail As“ + + + + + “Export the current document in one of the available formats, and attach it to the e-mail.“ + + + + + “E-Mail As…“ + + + + + “Image File“ + + + + + “BMP, GIF, JPEG, PNG, TIFF, EMF, WMF“ + + + + + “Export the document to Image and attach it to the e-mail.“ + + + + + “E-Mail As Image“ + + + + + “MHT File“ + + + + + “Single File Web Page“ + + + + + “Export the document to MHT and attach it to the e-mail.“ + + + + + “E-Mail As MHT“ + + + + + “PDF File“ + + + + + “Adobe Portable Document Format“ + + + + + “Export the document to PDF and attach it to the e-mail.“ + + + + + “E-Mail As PDF“ + + + + + “RTF File“ + + + + + “Rich Text Format“ + + + + + “Export the document to RTF and attach it to the e-mail.“ + + + + + “E-Mail As RTF“ + + + + + “Text File“ + + + + + “Plain Text“ + + + + + “Export the document to Text and attach it to the e-mail.“ + + + + + “E-Mail As Text“ + + + + + “XLS File“ + + + + + “Microsoft Excel 2000-2003 Workbook“ + + + + + “Export the document to XLS and attach it to the e-mail.“ + + + + + “E-Mail As XLS“ + + + + + “XLSX File“ + + + + + “Microsoft Excel 2007 Workbook“ + + + + + “Export the document to XLSX and attach it to the e-mail.“ + + + + + “E-Mail As XLSX“ + + + + + “XPS File“ + + + + + “XPS“ + + + + + “First Page“ + + + + + “Navigate to the first page of the document.“ + + + + + “First Page (Ctrl+Home)“ + + + + + “Last Page“ + + + + + “Navigate to the last page of the document.“ + + + + + “Last Page (Ctrl+End)“ + + + + + “Next Page“ + + + + + “Navigate to the next page of the document.“ + + + + + “Next Page (PageDown)“ + + + + + “Previous Page“ + + + + + “Navigate to the previous page of the document.“ + + + + + “Previous Page (PageUp)“ + + + + + “Thumbnails“ + + + + + “Open the Thumbnails.“ + + + + + “Thumbnails“ + + + + + “Watermark“ + + + + + “Insert ghosted text or image behind the content of a page.\r\n\r\nThis is often used to indicate that a document is to be treated specially.“ + + + + + “Watermark“ + + + + + “Zoom“ + + + + + “Change the zoom level of the document preview.“ + + + + + “Zoom“ + + + + + “Exact“ + + + + + “Zoom In“ + + + + + “Zoom in to get a close-up view of the document.“ + + + + + “Zoom In“ + + + + + “Zoom Out“ + + + + + “Zoom out to see more of the page at a reduced size.“ + + + + + “Zoom Out“ + + + + + “BMP Bitmap Format“ + + + + + “CSV Document“ + + + + + “DOCX Document“ + + + + + “EMF Enhanced Windows Metafile“ + + + + + “GIF Graphics Interchange Format“ + + + + + “HTML Document“ + + + + + “JPEG File Interchange Format“ + + + + + “MHT Document“ + + + + + “Native Format“ + + + + + “PDF Document“ + + + + + “PNG Portable Network Graphics Format“ + + + + + “Rich Text Document“ + + + + + “TIFF Tag Image File Format“ + + + + + “Text Document“ + + + + + “WMF Windows Metafile“ + + + + + “XLS Document“ + + + + + “XLSX Document“ + + + + + “XPS Document”“ + + + + + “Save As“ + + + + + “{0} of {1}“ + + + + + “Nothing“ + + + + + “Page {0} of {1}“ + + + + + “Page number in document. Click to open the Go To Page dialog.“ + + + + + “Stop“ + + + + + “Zoom Factor:“ + + + + + “Adjust to:“ + + + + + “Fit to“ + + + + + “% normal size“ + + + + + “pages wide“ + + + + + “Page“ + + + + + “Digitally signed by“ + + + + + “Date:“ + + + + + “DN:“ + + + + + “Location:“ + + + + + “Reason:“ + + + + + “your common name here“ + + + + + “your distinguished name here“ + + + + + “your signing location here“ + + + + + “your signing reason here“ + + + + + “Digital Signature“ + + + + + “Background“ + + + + + “Close Preview“ + + + + + “Customize“ + + + + + “Header And Footer“ + + + + + “Export Document…“ + + + + + “First Page“ + + + + + “Hand Tool“ + + + + + “Highlight Editing Fields“ + + + + + “Last Page“ + + + + + “Magnifier“ + + + + + “Document Map“ + + + + + “Multiple Pages“ + + + + + “Next Page“ + + + + + “Open a document“ + + + + + “Page Setup“ + + + + + “Parameters“ + + + + + “Previous Page“ + + + + + “Print“ + + + + + “Quick Print“ + + + + + “Save the document“ + + + + + “Scale“ + + + + + “Search“ + + + + + “Send via E-Mail…“ + + + + + “Thumbnails“ + + + + + “Watermark“ + + + + + “Zoom“ + + + + + “Zoom In“ + + + + + “Zoom Out“ + + + + + “Please Wait“ + + + + + “(Picture)“ + + + + + “(Text)“ + + + + + “Backward Diagonal“ + + + + + “Forward Diagonal“ + + + + + “Horizontal“ + + + + + “Vertical“ + + + + + “Center“ + + + + + “Left“ + + + + + “Right“ + + + + + “Clip“ + + + + + “Stretch“ + + + + + “Zoom“ + + + + + “Select Picture“ + + + + + “Bottom“ + + + + + “Middle“ + + + + + “Top“ + + + + + “ASAP“ + + + + + “CONFIDENTIAL“ + + + + + “COPY“ + + + + + “DO NOT COPY“ + + + + + “DRAFT“ + + + + + “EVALUATION“ + + + + + “ORIGINAL“ + + + + + “PERSONAL“ + + + + + “SAMPLE“ + + + + + “TOP SECRET“ + + + + + “URGENT“ + + + + + Contains padding or margin information associated with a control or a brick. + + + + + Initializes a new instance of the class and copies the settings from the object passed as the parameter according to the specified dpi value. + + A object whose settings are used to initialize the created object’s properties. + A value that specifies the dpi of the padding. This value is assigned to the PaddingInfo.Dpi property. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the dpi of the specified graphics unit. + + A value that specifies the graphics unit of the padding. The dpi value of the graphics unit is assigned to the PaddingInfo.Dpi property. + + + + Initializes a new instance of the class with the specified left, right, top and bottom values, and the dpi of the specified graphics unit. + + An integer value that specifies the left value of the padding. This value is assigned to the PaddingInfo.Left property. + An integer value that specifies the right value of the padding. This value is assigned to the PaddingInfo.Right property. + An integer value that specifies the top value of the padding. This value is assigned to the PaddingInfo.Top property. + An integer value that specifies the bottom value of the padding. This value is assigned to the PaddingInfo.Bottom property. + A value that specifies the graphics unit of the padding. The dpi value of the graphics unit is assigned to the PaddingInfo.Dpi property. + + + + Initializes a new instance of the class with the specified left, right, top, bottom and dpi values. + + An integer value that specifies the left value of the padding. This value is assigned to the PaddingInfo.Left property. + An integer value that specifies the right value of the padding. This value is assigned to the PaddingInfo.Right property. + An integer value that specifies the top value of the padding. This value is assigned to the PaddingInfo.Top property. + An integer value that specifies the bottom value of the padding. This value is assigned to the PaddingInfo.Bottom property. + A value that specifies the dpi of the padding. This value is assigned to the PaddingInfo.Dpi property. + + + + Initializes a new instance of the class with the specified left, right, top and bottom values. + + An integer value that specifies the left value of the padding. This value is assigned to the PaddingInfo.Left property. + An integer value that specifies the right value of the padding. This value is assigned to the PaddingInfo.Right property. + An integer value that specifies the top value of the padding. This value is assigned to the PaddingInfo.Top property. + An integer value that specifies the bottom value of the padding. This value is assigned to the PaddingInfo.Bottom property. + + + + Initializes a new instance of the class with the specified settings. + + An integer value, specifying the overall padding. + A value, specifying the dpi. + + + + Initializes a new instance of the class with the specified dpi value. + + A value that specifies the dpi of the padding. This value is assigned to the PaddingInfo.Dpi property. + + + + Specifies padding for all the element’s sides. + + An integer value, representing the overall padding. + + + + Gets or sets the padding value for the bottom edge. + + An integer value which represents the padding value (in pixels) for the bottom edge. + + + + Deflates the specified rectangle by the rectangle of the current padding with the specified dpi. + + A value which specifies the rectangle to be deflated. + A value which specifies the dpi value to be applied to the left, top, right and bottom padding values before deflating. + A value that represents the deflated rectangle. + + + + Deflates the specified size by the size of the current padding with the specified dpi. + + A value which specifies the size to be deflated. + A value which specifies the dpi value to be applied to the left, top, right and bottom padding values before deflating. + A value that represents the deflated size. + + + + Deflates the specified height value by the height of the current padding with the specified dpi. + + A value which specifies the height to be deflated. + A value which specifies the dpi value to be applied to the top and bottom padding values before deflating. + A value that represents the deflated height. + + + + Deflates the specified height value by the height of the current padding. + + A value which specifies the height to be deflated. + A value that represents the deflated height. + + + + Deflates the specified width value by the width of the current padding with the specified dpi. + + A value which specifies the width to be deflated. + A value which specifies the dpi value which should be applied to the left and right padding values before deflating. + A value that represents the deflated width. + + + + Deflates the specified width value by the width of the current padding. + + A value which specifies the width to be deflated. + A value that represents the deflated width. + + + + Gets or sets the dpi value used to perform internal calculations. + + A value which represents the dpi value for this padding. + + + + Provides a object with no padding. + + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Inflates the specified rectangle by the rectangle of the current padding with the specified dpi. + + A value which specifies the rectangle to be inflated. + A value which specifies the dpi value to be applied to the left, top, right and bottom padding values before inflating. + A value that represents the inflated rectangle. + + + + Inflates the specified size by the size of the current padding with the specified dpi. + + A value which specifies the size to be inflated. + A value which specifies the dpi value to be applied to the left, top, right and bottom padding values before inflating. + A value that represents the inflated size. + + + + Inflates the specified height value by the height of the current padding with the specified dpi. + + A value which specifies the height to be inflated. + A value which specifies the dpi value to be applied to the top and bottom padding values before inflating. + A value that represents the inflated height. + + + + Inflates the specified height value by the height of the current padding. + + A value which specifies the height to be inflated. + A value that represents the inflated height. + + + + Inflates the specified width value by the width of the current padding with the specified dpi. + + A value which specifies the width to be inflated. + A value which specifies the dpi value which should be applied to the left and right padding values before inflating. + A value that represents the inflated width. + + + + Inflates the specified width value by the width of the current padding. + + A value which specifies the width to be inflated. + A value that represents the inflated width. + + + + Determines whether the padding is empty (all padding values are null). + + true if the padding is empty; otherwise, false. + + + + Gets or sets the padding value for the left edge. + + An integer value which represents the padding value (in pixels) for the left edge. + + + + Gets or sets the padding value for the right edge. + + An integer value which represents the padding value (in pixels) for the right edge. + + + + Rotates padding values counterclockwise the specified number of times. + + An integer value which specifies the number of times for padding values to rotate. + + + + Gets or sets the padding value for the top edge. + + An integer value which represents the padding value (in pixels) for the top edge. + + + + Contains the values that define what kind of information is displayed in the current . + + + + + Indicates that the current date and time are displayed in the . + + + + + Indicates that the PageInfoTextBrick.Format property value is displayed in the current . + + + + + Indicates that the current page number is displayed in the . + + + + + Indicates that both the current page number and the total number of pages in the current report are displayed in the current . + + + + + Indicates that the current page number is displayed in the using roman numerals in uppercase. + + + + + Indicates that the current page number is displayed in the using roman numerals in lowercase. + + + + + Indicates that the total number of pages is displayed in the PageInfoBrick. + + + + + Indicates that the user name for the current thread is displayed in the . + + + + + Specifies the commands which can be executed in the printing system’s document preview. + + + + + Identifies the Background menu item, which is a parent for the FillBackground and Watermark subitems. Use this value as a parameter for the PrintingSystemBase.SetCommandVisibility method, to hide or show the Background items from the menu of the Print Preview form. + + + + + Closes the preview window. + + + + + Copies the selected document content to the Clipboard. + + + + + Invokes the property editor of the component which is about to be printed. Note that this component should implement the IPrintable interface. + + + + + Shows or hides the Document Map pane, which displays the hierarchy of bookmarks in a report document. + + + + + Invokes the Header/Footer Editor dialog. This dialog is used to insert standard page information into a report’s headers and footers. + + + + + Exports a document to a CSV (comma-separated values) file. + + + + + Exports the current document to a DOCX file. + + + + + Exports the current document to a file (a report can be exported to PDF, RTF, HTML, MHT, XLS, TXT, CSV and various image formats). + + + + + Exports the current document to a graphics file (BMP, EMF, GIF, JPEG, PNG, TIFF, WMF formats). + + + + + Exports the current document to an HTML file. + + + + + Exports the current document to an MHT file. + + + + + Exports the current document to a PDF file. + + + + + Exports the current document to an RTF file. + + + + + Exports the current document to a TXT file. + + + + + Exports the current document to an XLS file. + + + + + Exports the current document to an XLSX file. + + + + + Exports the current document to an XPS file. + + + + + + + Identifies the File menu item, which is a parent for the PageSetup, Print, PrintDirect, ExportFile and SendFile subitems. Use this value as a parameter for the PrintingSystemBase.SetCommandVisibility method, to hide or show the File items from the menu of the Print Preview form. + + + + + Invokes the Color dialog which allows the background color of the current document to be specified. + + + + + Invokes the Find dialog in the document’s preview. This dialog provides a search dialog which allows end-users to search a report for specific text directly in the preview window. + + + + + Raises the Go To Page dialog to jump to the specified page number. + + + + + Invokes or hides the Hand Tool in the document’s preview. This tool is used for scrolling the pages of the document being previewed. + + + + + Highlights all available fields whose content can be edited. + + + + + Invokes the preview magnifier. When the magnifier is activated the mouse cursor resembles a magnifying glass and a click on a preview page zooms in on it. There are two possible values for the magnification level. The first magnification value is always fixed and is equal to 100 %. The other value is calculated so that the entire preview page is visible at once without having to scroll it. + + + + + Shows the layout of the document’s preview across multiple pages. To specify a particular number of page rows and columns in a Print Control, use the DocumentViewerBase.SetPageView method. + + + + + Doesn’t identify any command. This member is intended for internal use only. + + + + + Opens a document. This command is represented both via the menu item and toolbar button. + + + + + Identifies the item which is the parent to the PageLayoutContinuous and PageLayoutFacing subitems. Use this value as a parameter for the PrintingSystemBase.SetCommandVisibility method to hide or show the page layout items from the menu of the Preview Form. + + + + + Changes the view of the document’s preview so that the pages are arranged as a continuous vertical column. + + + + + Changes the view of the document’s preview so that the pages are arranged side-by-side. + + + + + Selects the margin sizes for the entire document. Note that this command is in use in the Ribbon Print Preview Form only. + + + + + Switches the pages between portrait and landscape layouts. Note that this command is in use in the Ribbon Print Preview Form only. + + + + + Invokes the Page Setup dialog which allows some of the page’s settings to be adjusted (orientation, margins, paper size and source). + + + + + Chooses the paper size of the document. Note that this command is in use in the Ribbon Print Preview Form only. + + + + + Shows or hides the Parameters pane, which enables end-users to enter parameter values, apply them to a report’s data source and re-generate the report document. + + + + + Shows the mouse pointer, when there is no need to show either the Hand Tool, or the Magnifier. Note that this command is in use in the Ribbon Print Preview Form only. + + + + + Invokes the Print dialog for the current document. This dialog allows the printer to be selected, its properties set, the number of copies entered and the range of pages to print to be specified. + + + + + Prints the document preview directly, without any dialogs. This is useful when the printer’s settings don’t need to be changed before a document is printed. + + + + + Prints the selected document content. + + + + + Saves a document to a file. This command is represented both via the menu item and toolbar button. + + + + + Stretches or shrinks the document to a percentage of its actual size. Note that if you need to specify a particular scale factor or number of pages a document should be scaled to, the Document.ScaleFactor and Document.AutoFitToPagesWidth properties will be useful. + + + + + Scrolls one page down, as when an end-user presses the PAGE DOWN key. + + + + + Scrolls one page up, as when an end-user presses the PAGE UP key. + + + + + Exports the current document to a CSV (comma-separated values) file and sends it via e-mail. + + + + + Exports the current document to a DOCX file and sends it via e-mail. + + + + + Exports the document in the preview window, then creates a new e-mail in the default system mailer and attaches the exported document to the e-mail. The exporting format can be specified via the drop-down list. + + + + + Exports the current document to a graphics file (BMP, EMF, GIF, JPEG, PNG, TIFF, WMF formats) and sends it via e-mail. + + + + + Exports the current document to an MHT file and sends it via e-mail. + + + + + Exports the current document to a PDF file and sends it via e-mail. + + + + + Exports the current document to an RTF file and sends it via e-mail. + + + + + Exports the current document to a TXT file and sends it via e-mail. + + + + + Exports the current document to an XLS file and sends it via e-mail. + + + + + Exports the current document to an XLSX file and sends it via e-mail. + + + + + Exports the current document to a XPS file and sends it via e-mail. + + + + + + + Displays the first page in the preview. + + + + + Displays the last page in the preview. + + + + + Moves to the next page in the preview. + + + + + Moves to the previous page in the preview. + + + + + Identifies the Stop button, which is displayed in the status bar to the right of the progress bar, and can be used to stop generating a document. + + + + + Submits the parameters specified in the Parameters panel. + + + + + Toggles the Thumbnails panel visibility. + + + + + Identifies the View menu item, which is a parent for the PageLayout, Toolbar, Status Bar and Customize subitems. Use this value as a parameter for the PrintingSystemBase.SetCommandVisibility method, to hide or show the View items from the menu of the Print Preview form. + + + + + Zooms a document in or out so that only one entire page of the document is shown in the preview. + + + + + Invokes the Watermark dialog which can be used to specify either background text or a picture as a document’s watermark. Note that a document’s watermark can be accessed via the PrintingSystemBase.Watermark property. + + + + + Zooms in on a document by one of the predefined zoom factors. They are as follows: 10%, 25%, 50%, 75%, 100%, 150%, 200% and 500%. + + + + + Zooms the preview in. Each time this command is performed, the preview gets zoomed in by approximately 10%. + + + + + Zooms the preview out. Each time this command is performed, the preview gets zoomed out by approximately 10%. + + + + + Zooms a document in or out as appropriate, so that the width of the current page fits the preview window. + + + + + Zooms a document in or out as appropriate, so that the width of the text in the current page fits the preview window. + + + + + Zooms a document in or out as appropriate, so that only two entire pages of the document are shown in the preview. + + + + + Zooms a document in or out as appropriate, so that only a single page of the document is shown in the preview. + + + + + Identifies the Zoom trackbar control, which is available in the bottom-right corner of the Print Preview Form with a Ribbon. + + + + + Specifies how the text associated with the control should be aligned. + + + + + The text is vertically aligned at the bottom, and horizontally aligned at the center. + + + + + The text is vertically aligned at the bottom, and horizontally justified. + + This mode is ignored in Silverlight applications. + + + + + The text is vertically aligned at the bottom, and horizontally aligned on the left. + + + + + The text is vertically aligned at the bottom, and horizontally aligned on the right. + + + + + The text is vertically aligned in the middle, and horizontally aligned at the center. + + + + + The text is vertically aligned in the middle, and horizontally justified. + + This mode is ignored in Silverlight applications. + + + + + The text is vertically aligned in the middle, and horizontally aligned on the left. + + + + + The text is vertically aligned in the middle, and horizontally aligned on the right. + + + + + The text is vertically aligned at the top, and horizontally aligned at the center. + + + + + The text is vertically aligned at the top, and horizontally justified. + + This mode is ignored in Silverlight applications. + + + + + The text is vertically aligned at the top, and horizontally aligned on the left. + + + + + The text is vertically aligned at the top, and horizontally aligned on the right. + + + + + Lists the values indicating the available text rendering modes. + + + + + Antialiased glyph bitmaps without hinting is used. + + + + + Antialiased glyph bitmaps and hinting are used. + + + + + ClearType glyph bitmaps and hinting are used. + + + + + Glyph bitmaps without hinting are used. + + + + + Glyph bitmaps and hinting are used. + + + + + The system default rendering is used. + + + + + Specifies how content bricks are split if they are partially positioned outside the right page margin. + + + + + When the brick dimensions do not fit into the right page margin, the rest of the brick content is split across two pages. + + + + + When the brick dimensions do not fit into the right page margin, the brick content is moved to a new page in its entirety. + + + + + Settings to configure the Reporting UI components. + + + + + Contains settings that configure the user interface related to the data sources in the Report Designer. + + + + + Initializes a new instance of the class. + + + + + Hides the UI element that allows a user to remove the data source from the Web End-User Report Designer in the Field List. + + true to show the UI element that allows a user to remove the data source from the Web End-User Report Designer in the Field List; otherwise, false. + + + + Hides UI elements that allow the user to edit the data source and queries in the Field List. + + true to show UI elements that allow the user to edit the data source and queries in the Field List; otherwise, false. + + + + Hides the UI element that allows a user to remove the data source from the Web End-User Report Designer in the Field List. + + true to show the UI element that allows a user to remove the data source from the Web End-User Report Designer in the Field List; otherwise, false. + + + + Copies all the settings from the object passed as the parameter. + + A object whose settings are assigned to the current object. + + + + Provides the functionality that is necessary for deep customization of the End-User Report Designer. + + + + + Lists the values that define the order in which complex properties are shown in the Field List. + + + + + The default order of showing complex properties in the Field List is preserved. + + + + + The complex properties are shown at the top of the Field List. + + + + + The complex properties are shown at the bottom of the Field List. + + + + + Contains classes that are used to handle parameters in XtraReports. + + + + + A predefined value range item. + + The range type. + + + + Initializes a new instance of the class with specified settings. + + A range’s start value. + A range’s end value. + + + + The range’s end value. + + The range’s end value. + + + + Determines whether the specified object is equal to the current object. + + An object to compare with the current object. + true, if the specified object is equal to the current object; otherwise, false. + + + + Returns the hash code for the current object. + + The hash code for the current object. + + + + The range’s start value. + + The range’s start value. + + + + Contains classes that implement the basic functionality of XtraReports. + + + + + Specifies the type of the value returned by a calculated field. + + + + + Indicates that the field returns a Boolean (true or false) value (the type). + + + + + Indicates that the field returns an 8-bit unsigned integer value (the type). + + + + + Indicates that the field returns a value expressed as a date and time of day (the type). + + + + + Indicates that the field returns a decimal value (the type). + + + + + Indicates that the field returns a double-precision floating-point value (the type). + + + + + Indicates that the field returns a single-precision floating-point value (the type). + + + + + Indicates that the field returns a globally unique identifier value (the System.Guid type). + + + + + Indicates that the field returns a 16-bit signed integer value (the type). + + + + + Indicates that the field returns a 32-bit signed integer value (the type). + + + + + Indicates that the field’s type is undefined and determined by evaluating the actually returned object during report generation. + + + + + Indicates that the field returns a string value as a sequence of UTF-16 code units (the type). + + + + + Indicates that the field returns a value as a time interval (the type). + + + + + Contains classes that provide the data contracts functionality to the Web Report Designer. + + + + + Initializes a new instance of the class. + + + + + Contains settings that apply to the Report Designer Preview. + + + + + Initializes a new instance of the class. + + + + + Copies the settings from the specified object to the current object. + + A object whose settings are assigned to the current object. + + + + Allows you to specify settings that apply to print and export operations. + + A class that contains settings that apply to print and export operations. + + + + Allows you to specify the Report Designer Preview‘s search settings. + + A class that contains settings that apply to search operations. + + + + Lists settings that specify the visibility of the search box on the Report Wizard’s Select Report Type page. + + + + + The search box is always displayed. + + + + + The search box is displayed automatically depending on the number of report items shown. + + + + + The search box is always hidden. + + + + + Contains the Report Wizard settings. + + + + + Initializes a new instance of the class. + + + + + Copies all the settings from the object passed as the parameter. + + A object whose settings are assigned to the current object. + + + + Allows you to hide the Data Federation option and related pages in the Data Source Wizard. + + true to enable the Data Federation option; otherwise, false. + + + + Allows you to hide the JSON data source option and related pages in the Data Source Wizard. + + true to enable the JSON data source option; otherwise, false. + + + + Allows you to hide the Object Data Source option and related pages in the Data Source Wizard. + + true to enable the Object Data Source option; otherwise, false. + + + + Allows you to hide the Database option and related pages in the Data Source Wizard. + + true to enable the Database option; otherwise, false. + + + + Specifies whether to display the search box on the Select Report Type page. + + The enumeration member that specifies whether to display the report template search box. + + + + Specifies whether the Report Wizard operates in a full-screen page with complex layout or in a popup window with plain layout. + + true, to use the full-screen Report Wizard version; false, to use the legacy Report Wizard version. + + + + Specifies whether the Report Wizard displays a full page with complex layout that enables you to create master-detail reports and specify grouping and summary options. + + true, to use the master-detail Report Wizard version; false, to use the legacy Report Wizard version. + + + + Contains settings for the Web Report Designer model. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether a user can close all reports designed in the Report Designer and leave the designer empty, or with only a single report. + + True to allow the user to close all reports; false if a single report remains. + + + + Copies the settings from the specified object to the current object. + + A object whose settings are assigned to the current object. + + + + Specifies settings that configure the user interface related to the data sources in the Report Designer. + + A object that contains settings for UI configuration related to the data sources in the Report Designer. + + + + Enables or disables a right-to-left layout in the Web Report Designer user interface. + + true to enable the right-to-left layout in the Report Designer UI; otherwise, false. + + + + Provides access to the Report Wizard settings. + + A object that contains the Report Wizard settings. + + + + Contains classes that store the session settings of a Web Document Viewer. + + + + + Contains serializable classes that define data contracts. + + + + + Contains settings that apply to Web Document Viewer print and export operations. + + + + + Initializes a new instance of the class. + + + + + Copies the settings from the specified object to the current object. + + A object whose settings are assigned to the current object. + + + + Specifies whether to display an additional dialog that allows users to download the PDF file sent to printing. + + true, to display an additional dialog; otherwise, false. + + + + Allows you to export documents asynchronously. + + True to perform export operations asynchronously; false to export documents in the same UI thread. + + + + Specifies whether to print and export documents in the browser tab that contains the Document Viewer. + + true, to print and export documents in the tab that contains the Document Viewer; false to open another browser tab for print and export. + + + + Stores settings of the Mobile Document Viewer. + + + + + Initializes a new instance of the class. + + + + + Specifies whether animation is enabled for actions in Mobile Mode. + + true, to enable animation; otherwise, false. + + + + Specifies whether the Mobile Viewer operates in Reader Mode in which document pages are displayed without borders. + + true, to enable Reader Mode; otherwise, false. + + + + Contains settings for the progress bar that appears when a report is generated. + + + + + For internal use. + + + + + Gets or sets whether the progress bar stays on the visible area when users scroll a web page that contains the Document Viewer. + + true, if the progress bar should stay on the visible area; otherwise,false. + + + + Gets or sets the progress bar’s position within the Document Viewer‘s visible area. + + The progress bar’s position. + + + + Provides settings for the Web Document Viewer‘s remote document source. + + + + + Initializes a new instance of the class. + + + + + Specifies an access token used to obtain documents from the Report and Dashboard Server. + + A value that specifies an access token. + + + + Specifies the Report and Dashboard Server URI. + + A value that specifies the Report and Dashboard Server URI. + + + + Initializes a new instance of the class. + + + + + Contains settings that apply to the Web Document Viewer‘s search operations. + + + + + Initializes a new instance of the class. + + + + + Copies the settings from the specified object to the current object. + + A object whose settings are assigned to the current object. + + + + Allows you to hide the search actions. + + true to show search actions; otherwise, false. + + + + Specifies whether the Web Document Viewer uses asynchronous search. + + true to use asynchronous search; otherwise, false. + + + + Provides settings for the Web Document Viewer‘s tab panel. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the tab panel’s position. + + A enumeration value that specifies the tab panel position. + + + + Specifies the tab panel’s width. + + An integer value that specifies the tab panel position. + + + + Specifies where to position the progress bar while a report is generated. + + + + + The progress bar is positioned in the Document Viewer’s bottom left corner. + + + + + The progress bar is positioned in the Document Viewer’s bottom right corner. + + + + + The progress bar is positioned in the Document Viewer’s bottom left corner for left-to-right text direction, or in the bottom right corner for right-to-left text direction. + + + + + The progress bar is positioned in the Document Viewer’s top left corner. + + + + + The progress bar is positioned in the Document Viewer’s top right corner. + + + + + Initializes a new instance of the class. + + + + + Base class for the Web Document Viewer control settings. + + + + + Enables accessibility mode. + + True to enable accessibility mode; otherwise, false. + + + + Allows you to specify settings that apply to print and export operations. + + A class that contains settings that apply to print and export operations. + + + + Enables or disables a right-to-left layout in the Web Report Designer user interface. + + true to enable the right-to-left layout in the Report Designer UI; otherwise, false. + + + + Allows you to specify the Web Document Viewer‘s search settings. + + A class that contains settings that apply to search operations. + + + + Contains classes which are used to implement the main functionality of the XtraSpellChecker. + + + + + Provides data for the AfterCheckWord event. + + + + + Initializes a new class instance with specified settings. + + An object, representing the control being checked. + A string, representing a word before the check. + A string, representing the word modified after the spell check. + A enumeration value, representing the operation type. + A DevExpress.XtraSpellChecker.Parser.Position object, representing the position in the text where the checked word begins. + + + + Gets the word which replaced the former one after the spelling check is performed. + + A string, representing the word modified after spelling check. + + + + Gets the control being checked. + + An object representing a control being checked. + + + + Gets the type of operation performed with the word in a spell check. + + A enumeration value, representing the operation type. + + + + Gets the word before the spell check is performed. + + A string, representing a word before the check. + + + + Gets the position of a checked word in a text. + + A DevExpress.XtraSpellChecker.Parser.Position object, representing the position in a text where the checked word begins. + + + + Represents a method that will handle the SpellCheckerBase.AfterCheckWord event. + + An object that triggers the SpellCheckerBase.AfterCheckWord event. + A object that provides data for the SpellCheckerBase.AfterCheckWord event. + + + + Lists result types of spelling check. + + + + + A misspelled word is found. + + + + + A repeating word is found. + + + + + No errors are found + + + + + Represents the result of the spelling check. + + + + + Gets whether the spelling error is found during a spelling check. + + true if a spelling error is found; otherwise, false. + + + + Gets the index of a checked word in a text. + + An integer representing the index of a word in a text. + + + + Gets the length of a checked word. + + An integer representing the number of positions the checked word occupies. + + + + Indicates the result of checking a word. + + A enumeration member. + + + + Gets the text being checked. + + A string containing the text being checked. + + + + Gets the checked word. + + A string representing the checked word. + + + + An interface used to represent a list of words ignored during spell check. + + + + + Adds a specified word to a list of ignored words, so that it is ignored only in the specified location. + + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text. + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text. + A string representing a word to be ignored if located between the start and the end positions. + + + + Adds a specified word to a list of ignored words. + + A string representing a word to be ignored. + + + + Removes all items from the ignore list. + + + + + Determines whether a word is in the list of ignored words, ignored in the specified location. + + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text being checked. + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text being checked. + A string to locate in the list of ignored words. + true if the word is found within the list and marked as effective in the specified location; otherwise false. + + + + Determines whether a word is in the list of ignored words. + + A string to locate in the list of ignored words. + true if the word is found within the list; otherwise false. + + + + Removes a word from the list of words ignored only once. + + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text being checked. + A DevExpress.XtraSpellChecker.Parser.Position object representing a position in the text being checked. + A string representing a word to remove from the list. + + + + Removes a word from the list. + + A string representing a word to remove form the list. + + + + The options used for the spelling check. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Start spelling check from the cursor position. + + A enumeration value, specifying whether the spell checker should start checking from the cursor position. + + + + Spell check the selected text first. + + A enumeration value specifying whether the spell checker should start checking the selected text first. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets or sets whether e-mail addresses should be excluded from the check. + + A enumeration value specifying whether words that are e-mail addresses should be checked. + + + + Gets or sets whether text enclosed with specific markup tags should be checked. + + true to exclude text within tags from the check; otherwise, false. + + + + Gets or sets whether the spell checker ignores words containing different case letters in positions other than the first. + + A enumeration value specifying whether mixed case words should be checked. + + + + Gets or sets whether the spell checker ignores repeated words. + + A enumeration value specifying whether the text should be checked for repeated words. + + + + Gets or sets whether the spell checker ignores words in which all letters are uppercase. + + A enumeration value, specifying whether the words in which all letters are uppercase should be checked. + + + + Gets or sets whether the spell checker ignores the URLs in text. + + A enumeration value, specifying whether the words which are URLs should be checked. + + + + Gets or sets whether the spell checker ignores words that contain numbers. + + A enumeration value, specifying whether the words which contain numbers should be checked. + + + + Occurs when any of the spelling check options are changed. + + + + + The base interface for a spell checker. + + + + + Add a word to a custom dictionary. + + A word to add. + A object used to select a dictionary for the specified word. + + + + Add a word to a custom dictionary. + + A word to add. + + + + Occurs after a word is checked. + + + + + Determines whether a word can be added to a custom dictionary. + + true if a word can be added to the dictionary; otherwise, false. + + + + Determines whether words of the specified language can be added to the dictionary. + + A object that specifies the language of the required dictionary. + true, if the words can be added to the dictionary; otherwise, false. + + + + Checks the spelling of the text available through the controller interface in the specified range and returns on the first error that occurrs. + + An object that is a control to be checked for spelling mistakes. + An object implementing the DevExpress.XtraSpellChecker.Parser.ISpellCheckTextController interface providing text to check. + A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position where the check statrs. + A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position where the check finishes. + An object with the interface providing information on the error type and position. + + + + Checks the specified control for spelling mistakes. + + A object, representing a control to be checked for spelling mistakes. + + + + Checks the specified text in the specified control with the specified culture. + + A control to check. + A string that is a text to check. + An integer specifying the start position within the string. + The object that specifies the culture settings (the symbols encoding, language and phonetic specifics). + An object exposing the interface. + + + + Gets or sets the culture-specific settings of the spell checker. + + A object that specifies culture settings (the symbols encoding, language and phonetic specifics). + + + + Occurs when the current culture setting of a spell checker is changed. + + + + + Occurs when a custom dictionary is modified by an end-user. + + + + + Provides access to spell checking options for a specified control. + + A control for which spelling options are set. + An object exposing the interface. + + + + Constructs an ordered list of suggestions for a given word. + + A System.String representing a word for which the suggestions should be calculated. + A object specifying the culture, ensuring that the proper dictionaries are loaded. + A object representing a sorted list of suggested words. + + + + Disregards a word in a text. + + A control whose content is checked. + A word to ignore while checking. + The position from which to start ignoring the word. + Position to finish ignoring the word. + + + + Skips the specified word throughout the entire content of the specified control. + + A control whose content is checked. + A word to ignore. + + + + Gets whether the spell checker is checking the content. + + true if a spell checker is checking the content; otherwise, false. + + + + Registers a list of words as the words to ignore while checking. + + A control whose content is checked. + An object exposing the interface and representing a list of words to skip. + + + + Gets or sets the spell check mode. + + A enumeration member. + + + + Occurs when the SpellCheckMode is changed. + + + + + Unregisters the previously registered list of words which should be skipped while checking. + + A control whose content is checked. + + + + Occurs after a word is added to a custom dictionary. + + + + + Comprises erroneous word, error type and location. + + + + + Gets the error type. + + A enumeration member. + + + + Gets a misspelled word. + + A string that is the misspelled word. + + + + Gets the end position of a misspelled word. + + A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position of the word. + + + + Gets the start position of a misspelled word. + + A DevExpress.XtraSpellChecker.Parser.Position object containing information on the position of the word. + + + + Lists available operation modes of the spell checker. + + + + + Starts spelling check when you finish typing the word or move the cursor after changing it.This operation mode underlines the misspelled word and allows you to select a suggestion from the context menu, invoked by right-clicking the word. + + + + + Starts spelling check and invokes the spelling form for making corrections. + + + + + Lists implemented spell checker operations. + + + + + Replaces a word in the text with the user input, and adds the replacement to the custom dictionary. + + + + + Stops the spelling checker operation, resets the checking strategy and closes the spelling form. + + + + + Replaces the current word in the text being checked with the suggested word. + + + + + Replaces all occurences of the current word in the text being checked with the suggested word. + + + + + This enumeration member is intended for internal use only. + + + + + Deletes the current word from the text. + + + + + Disregards the current word and proceeds to the next one. + + + + + Disregards the current word and all its occurences in the text. + + + + + This enumeration member is intended for internal use only. + + + + + Invokes the spelling options form. After closing the form, re-checks the text with new spelling options starting with the last checked word. + + + + + Forces the spell checker to check the last checked word again. + + + + + Replaces the current word in the text being checked with the suggested word. For internal use. + + + + + Disregards the current word and proceeds to the next one. For internal use. + + + + + Cancels the effect of the last operation, restoring the text to its previous state. + + + + + Lists error types found during a spell check. + + + + + Erroneously spelled word. + + + + + Repeated word. + + + + + Reserved for internal use. + + + + + Error type unlisted in enumeration. Use it for custom error handling. + + + + + Provides data for the ISpellChecker.WordAdded and SpellCheckerBase.WordAdded events. + + + + + Initializes a new instance of the class with the specified settings. + + A word that has been added to the custom dictionary. + + + + Gets a word added to the dictionary. + + A string representing a word added to the dictionary. + + + + Represents a method that will handle the ISpellChecker.WordAdded event. + + An object of any type that triggers the ISpellChecker.WordAdded event. + A object that provides data for the ISpellChecker.WordAdded event. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.dll new file mode 100644 index 0000000..1c1700e Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.xml new file mode 100644 index 0000000..4c08055 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Drawing.v23.2.xml @@ -0,0 +1,4457 @@ + + + + DevExpress.Drawing.v23.2 + + + + + Contains cross-platform counterparts of the System.Drawing classes not supported in non-Windows environments. + + + + + An adjustable arrow-shaped line cap. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The width of the arrow. + The height of the arrow. + The amount by which to scale the line cap with respect to the width of the DXPen object. + true to fill the arrow cap; otherwise, false. + + + + Determines whether the specified object is equal to the current DXAdjustableArrowCap instance. + + The object to compare. + true if the obj parameter is DXFont and has the same property values as the current DXAdjustableArrowCap instance; otherwise, false. + + + + Gets or sets whether the arrow cap is filled. + + true if the arrow cap is filled; otherwise, false. + + + + Gets the hash code for the DXAdjustableArrowCap object. + + The hash code. + + + + Gets or sets the height of the arrow cap. + + The cap height. + + + + Gets or sets the number of units between the outline of the arrow cap and the fill. + + The number of units between the outline of the arrow cap and the fill of the arrow cap. + + + + Gets or sets the width of the arrow cap. + + The arrow cap width. + + + + Encapsulates a bitmap which consists of the pixel data for a graphics image and its attributes. + + + + + Initializes a new instance of the class with specified settings. + + The bitmap width, in pixels. + The bitmap height, in pixels. + + + + Clones the current DXBitmap object. + + A copy of the DXBitmap object. + + + + Crops the bitmap to the specified rectangle. + + An area to which the bitmap should be cropped. + The resulting bitmap. + + + + Crops the bitmap to the specified rectangle. + + An area to which the bitmap should be cropped. + The resulting bitmap. + + + + Determines whether the specified object is equal to the current DXBitmap instance. + + An object to compare. + true if the object parameter has the same property values as the current DXBitmap instance; otherwise, false. + + + + Determines whether the specified object is equal to the current DXBitmap instance. + + An object to compare. + true if the object parameter has the same property values as the current DXBitmap instance; otherwise, false. + + + + Gets a hash code for the DXBitmap object. + + The hash code. + + + + Gets the color of the specified pixel. + + The x-coordinate of the pixel to retrieve. + The y-coordinate of the pixel to retrieve. + The color of the specified pixel. + + + + Rotates and flips the image. + + An enumeration value that indicates the rotation and flip type. + + + + Defines blending patterns. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The number of elements in Factors and Positions arrays. + + + + Gets or sets an array of blend factors for the gradient. + + An array of blend factors that specify the percentages of the starting color and the ending color to be used at the corresponding position. + + + + Gets or sets an array of blend positions for the gradient. + + An array of blend positions that specify a distance along the gradient line as a percentage. + + + + Base class for brushes. + + + + + Clones the current DXBrush object. + + A copy of the current DXBrush object. + + + + Disposes of the DXBrush object. + + + + + Lists values that indicate how clipping regions can be combined. + + + + + Two clipping regions are combined by taking their intersection. + + + + + One clipping region replaces by another. + + + + + Defines arrays of colors and positions used to interpolate color blending in a multicolor gradient. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The numbers of colors and positions in the blend. + + + + Gets or sets the colors used at specified positions along a gradient. + + An array of colors used at specified positions along a gradient. + + + + Gets or sets the positions along a gradient line. + + An array of positions along a gradient line. + + + + Lists values that indicate how to combine source colors with background colors. + + + + + When a source color is rendered, it overwrites the background color. + + + + + When a source color is rendered, it blends with the background color. The blend is determined by the alpha component of the color being rendered. + + + + + A custom user-defined line cap. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the base cap for a custom cap. + + An enumeration value that indicates a base cap type. + + + + Gets or sets the distance between the cap and the line. + + The distance between the start of the cap and the end of the line. + + + + Determines whether the specified object is equal to the current DXCustomLineCap instance. + + An object to compare. + true if the obj parameter has the same property values as the current DXCustomLineCap instance; otherwise, false. + + + + Gets or sets the fill for the custom cap. + + The custom cap fill. + + + + Gets the hash code for the object. + + The hash code. + + + + Gets or sets the outline of the custom cap. + + The cap outline. + + + + A base class for custom user-defined line caps. + + + + + Determines whether the specified object is equal to the current DXCustomLineCapBase instance. + + An object to compare. + true if the obj parameter has the same property values as the current DXCustomLineCapBase instance; otherwise, false. + + + + Gets the hash code for the DXCustomLineCapBase instance. + + The hash code. + + + + Gets or sets the caps used to end lines that make up this custom cap. + + An enumeration value that indicates a cap used at the end of a line. + + + + Gets or sets how lines the compose the custom line cap are joined. + + An enumeration value that indicates the line join mode. + + + + Gets or sets the limit of the thickness of the join on a mitered corner. + + The limit of the thickness of the join on a mitered corner. + + + + Gets or sets the caps used to start lines that make up this custom cap. + + The enumeration value that indicates a cap used at the start of a line. + + + + Gets or sets the amount by which to scale the line cap with respect to the width of the DXPen object. + + The scaling amount. + + + + Lists values that indicate the type of graphic shape to use on both ends of each dash in a dashed line. + + + + + A square cap that squares off both ends of each dash. + + + + + A circular cap that rounds off both ends of each dash. + + + + + A square cap that rounds off both ends of each dash. + + + + + A triangular cap that points both ends of each dash. + + + + + Lists values that indicate the dashed line style. + + + + + A user-defined dash style. + + + + + A line that consists of short dashes. + + + + + A line that consists of a repeating short dash-dot pattern. + + + + + A line that consists of a repeating short dash-dot-dot pattern. + + + + + A line that consists of dots. + + + + + A solid line. + + + + + Lists values that indicate fill modes of a closed path interior. + + + + + The alternate fill mode. + + + + + The winding fill mode. + + + + + Contains the text format settings such as font size and style. + + + + + Initializes a new instance of the class with specified settings. + + A object that specifies the font. + A DXFontStyle object that specifies the font style. + + + + Initializes a new instance of the class with specified settings. + + A string that specifies the font name. + The size of the font. + A DXFontStyle object that specifies the font style. + A DXGraphicsUnit object that specifies the font’s unit of measure. + An array of DXFontAdditionalProperty objects that are additional font properties. + + + + Initializes a new instance of the class with specified settings. + + A string that specifies the font name. + The size of the font. + A DXFontStyle object that specifies the font style. + A DXGraphicsUnit object that specifies the font’s unit of measure. + + + + Initializes a new instance of the class with specified settings. + + A string that specifies the font name. + The size of the font in points. + A DXFontStyle object that specifies the font style. + + + + Initializes a new instance of the class with specified settings. + + A string that specifies the font name. + The size of the font in points. + + + + Gets a value that indicates whether the font is bold. + + true if the font is bold; otherwise, false. + + + + Creates a copy of the instance. + + The copy of the instance. + + + + Determines whether the specified object is equal to the current DXFont instance. + + A DXFont object to test. + true if the DXFont parameter has the same property values as the current DXFont instance; otherwise, false. + + + + Determines whether the specified object is equal to the current DXFont instance. + + The object to test. + true if the obj parameter is DXFont and has the same property values as the current DXFont instance; otherwise, false. + + + + Gets the hash code for DXFont. + + The hash code. + + + + Obtains the font height. + + The font height. + + + + Gets a value that indicates whether the italic style is applied to the font. + + true to indicate the font has the italic style applied; otherwise, false. + + + + Gets the font name. + + The name of the font. + + + + Gets the size of the font in units defined by the DXFont.Unit property. + + The size of the font. + + + + Gets the size of the font in points. + + The size of the font in points. + + + + Gets a value that indicates whether the font has a horizontal line through it. + + true if the font has a horizontal strikeout style; otherwise, false. + + + + Returns style information applied to the font. + + A DXFontStyle object that specifies the font style. + + + + Returns a string that specifies `DXFont’. + + A string that specifies DXFont. + + + + Gets a value that indicates whether the font is underlined. + + true if the font is underlined; otherwise, false. + + + + Obtains the font measurement unit. + + The measurement unit of the font. + + + + Contains additional font properties. + + + + + Initializes a new instance of the class with specified settings. + + The name of the property. + The property value. + + + + The GdGdiCharSet property name. + + The property name. + + + + The GdiVerticalFont property name. + + The property name. + + + + Obtains the property name. + + The property name. + + + + Obtains the property value. + + The property value. + + + + Contains information about a font in . + + + + + Initializes a new instance of the class with specified settings. + + The path to the font file. + The font name. + A zero-based index of the font within the TTC file. + true if the font is bold; otherwise, false. + true if the font style is italic; otherwise, false. + + + + Indicates whether the font is bold. + + true if the font is bold; otherwise, false. + + + + Returns the path to the font file (if the font is loaded from a file). + + The path to the font file. Null (Nothing in Visual Basic) if the font is loaded from a stream or byte array. + + + + Indicates whether the font style is italic. + + true if the font style is italic; otherwise, false. + + + + Returns the font name (including the Font Family and Font Subfamily names). + + The font name. + + + + Returns the font index in the TrueType Collection (TTC) file. + + A zero-based index of the font within the collection. + + + + A repository of user-defined fonts. + + + + + Loads a font from a byte array. + + A byte array that contains font data. + + + + Loads a font from a stream. + + A stream from which to load the font. + + + + Loads a font from a file. + + The full path to the font file. + + + + Removes all fonts from the font repository. + + + + + Releases resources associated with the instance. + + + + + Returns a list of all fonts in . + + A list of objects that contain information about fonts in the repository. + + + + Returns an instance of the class. + + The DXFontRepository class instance. + + + + Indicates whether the font repository is empty. + + true if the font repository contains no fonts; otherwise, false. + + + + Lists values that indicate style information applied to text. + + + + + Bold text. + + + + + Italic text. + + + + + Normal text. + + + + + Strike-through text. + + + + + Underlined text. + + + + + Allows you to draw graphics content. + + + + + Clears the entire drawing surface and fills it with the specified background color. + + The background color of the drawing surface. + + + + Obtains the clipping region of the graphics layout. + + The clipping region. + + + + Gets or sets how to draw composited images + + An enumeration value that determines the compositing mode. + + + + Disposes of the DXGraphics object. + + + + + Gets the horizontal resolution of the DXGraphics object. + + The horizontal resolution value. + + + + Gets the vertical resolution of the DXGraphics object. + + The vertical resolution value. + + + + Draws an arc specified by a rectangle. + + An object that determines the color, width, and style of the arc. + A rectangle that defines the ellipsis bounds. + Angle in degrees measured clockwise from the x-axis to the starting point of the arc. + Angle in degrees measured clockwise from the startAngle parameter to ending point of the arc. + + + + Draws a Bezier spline defined by points. + + An object that determines the color, width, and style of the curve. + The starting point of the curve. + The first control point of the curve. + The second control point of the curve. + The ending point of the curve. + + + + Draws a series of Bezier splines defined by an array of points. + + An object that determines the color, width, and style of the curve. + The points that determine the curve. The number of points in the array should be a multiple of 3 plus 1 (4, 7, 10, and so on). + + + + Draws an ellipse in the specified rectangle. + + An object that determines the color, width, and style of the ellipse. + The rectangle that defines the ellipsis bounds. + + + + Draws a portion of the image so that it fits into the specified rectnangle. + + An image to draw. + The image size and location. + The portion of the image to draw. + + + + Draws an image so that it fits into the specified rectnagle. + + An image to draw. + Specifies the location and size of the drawn image. + + + + Draws an image at the specified location. + + An image to draw. + The x-coordinate of the upper-left corner of the drawn image. + The y-coordinate of the upper-left corner of the drawn image. + + + + Draws a line that connects two points. + + An object that determines the color, width, and style of the line. + The starting point of the line. + The end point of the line. + + + + Draws a line that connects two points. + + An object that determines the color, width, and style of the line. + The x-coordinate of the first point. + The y-coordinate of the first point. + The x-coordinate of the second point. + The y-coordinate of the second point. + + + + Draws a series of lines that connects an array of points. + + An object that determines the color, width, and style of the line segments. + An array of points to connect. + + + + Draws a series of lines that connects an array of points. + + An object that determines the color, width, and style of the line segments. + An array of points to connect. + + + + Draws a DXGraphicsPath object. + + An object that determines the color, width, and style of the path. + A series of connected lines and curves. + + + + Draws a pie shape. + + An object that determines the color, width, and style of the pie shape. + The bounding rectangle that defines the pie ellipse. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Draws a polygon defined by an array of points. + + An object that determines the color, width, and style of the polygon. + An array of points that are the polygon vertices. + + + + Draws a rectangle. + + An object that determines the color, width, and style of the rectangle. + The rectangle to draw. + + + + Draws text in the specified rectangle. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines text font options. + An object that determines the color and texture of the drawn text. + A point where you can position text. + An object that specifies text formatting attributes. + + + + Draws text in the specified rectangle. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines text font options. + An object that determines the color and texture of the drawn text. + A location where the text should be drawn. + An object that specifies text formatting attributes. + + + + Fills the interior of an ellipse located in the specified rectangle. + + The brush used to fill the ellipse. + An area where you can draw an ellipse. + + + + Fills the interior of the specified path. + + The brush used to fill the path. + A path to fill. + + + + Fills the interior of the pie shape. + + The brush used to fill the pie shape. + An area where you can draw a pie shape. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Fills the interior of a polygon specified by array points. + + The brush used to fill the polygon. + An array of points that specify the polygon vertices. + + + + Fills the interior of a rectangle located in the specified area. + + The brush used to fill the rectangle. + An area where you can draw a rectangle. + + + + Fills the interior of a rectangle located in the specified area. + + The brush used to fill the rectangle. + The x-coordinate of the upper-left corner of the rectangle to fill. + The y-coordinate of the upper-left corner of the rectangle to fill. + Width of the rectangle to fill. + Height of the rectangle to fill. + + + + Fills the interior of a rectangle located in the specified area. + + The brush used to fill the rectangle. + A list of rectangles to fill. + + + + Fills the interior of a region. + + The brush used to fill the interior. + The area to fill. + + + + Forces execution of all pending graphics operations and returns immediately without waiting for the operations to finish. + + + + + Creates a new object from the specified image. + + An image form which to create a new DXGraphics object. + The resulting object. + + + + Gets a region that limits the drawing region of the graphics layout. + + A region that is currently available for drawing. + + + + Gets or sets the interpolation mode associated with the DXGraphics object. + + An enumeration value that indicates how to calculate intermediate values between two endpoints. + + + + Measures the specified string when drawn with the specified font, text layout size, and format. + + A string to measure. + An object that contains font parameters. + Specifies the maximum layout area for the text. + An object that contains text formatting parameters. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font, text layout size, and format. + + A string to measure. + An object that contains font parameters. + Specifies the maximum width for this text. + An object that contains text formatting parameters. + The string’s measured size. + + + + Multiplies the world transformation by a matrix in the specified order. + + A 4x4 matrix that multiplies the world transformation. + An enumeration member that determines the order of the multiplication. + + + + Multiplies the world transformation by the specified matrix. + + A 4x4 matrix that multiplies the world transformation. + + + + Gets or sets the scaling between world units and page units. + + The scale value. + + + + Gets or sets the measure units used for page coordinates. + + An enumeration value that indicates measure units. + + + + Resets the world transformation matrix to the identity matrix. + + + + + Restores the state of this DXGraphics to the specified state. + + The state to which to restore the DXGraphics object. + + + + Applies a rotation to the transformation matrix in the specified order. + + The rotation angle in degrees. + An enumeration member that specifies whether the rotation is appended or prepended to the matrix transformation. + + + + Applies the specified rotation to the transformation matrix. + + The rotation angle in degrees. + + + + Saves the current state of the DXGraphics object. + + The saved state. + + + + Scales the coordinate system by the specified scale factor. Allows you to set the operation order. + + Scale factor in the x direction. + Scale factor in the y direction. + An enumeration value that indicates the operation order. + + + + Scales the coordinate system by the specified scale factor. + + Scale factor in the x direction. + Scale factor in the y direction. + + + + Performs the specified combining operation with the current clip region and a DXGraphicsPath object and sets the clipping rerion to the operation result. + + A path to combine. + An enumeration that specifies the combining operation to use. + + + + Sets the clipping region of to the specified DXGraphicsPath object. + + A new clipping region. + + + + Performs the specified combining operation with the current clip region and another region and sets the clipping region to the operation result. + + A region to combine. + An enumeration that specifies the combining operation to use. + + + + Sets the clipping region to the specified region. + + The new clipping region. + + + + Performs the specified combining operation with the current clip region and a rectangle and sets the clipping region to the operation result. + + A rectangle to combine. + An enumeration that specifies the combining operation to use. + + + + Sets the clipping region to the specified rectangle. + + A new clipping region. + + + + Gets or sets the rendering quality. + + An enumeration value that indicates whether lines, curves, and the edges of filled areas use smoothing (also called antialiasing). + + + + Gets or sets the text rendering mode. + + An enumeration value that indicates whether text renders with antialiasing. + + + + Gets or sets a copy of the geometric world transformation. + + A copy of the DXMatrix that is the geometric world transformation. + + + + Translates the coordinate system origin to the specified point. + + The x-coordinate of the translation. + The y-coordinate of the translation. + An enumeration value that indicates the operation order. + + + + Translates the coordinate system origin to the specified point. + + The x-coordinate of the translation. + The y-coordinate of the translation. + + + + Defines a series of connected lines and curves. + + + + + Initializes a new instance of the class with specified settings. + + An enumeration value that indicates the fill mode of the closed path interior. + + + + Initializes a new instance of the class with specified settings. + + Graphics data (a list of points and types) to define the DXGraphicsPath instance. + + + + Initializes a new instance of the class with specified settings. + + A list of point coordinates that define the DXGraphicsPath instance. + A list of enumeration values that specify the type of each corresponding point in the points list. + An enumeration value that indicates the fill mode of the closed path interior. + + + + Appends an elliptical arc to the current figure. + + The rectangular bounds of the ellipse from which the arc is taken. + The starting angle of the arc, measured in degrees clockwise from the x-axis. + The angle between startAngle and the end of the arc. + + + + Appends an elliptical arc to the current figure. + + The x-coordinate of the rectangle’s upper-left corner. The rectangle defines the arc ellipse. + The y-coordinate of the rectangle’s upper-left corner. The rectangle defines the arc ellipse. + The width of the rectangle. The rectangle defines the ellipse from which the arc is drawn. + The height of the rectangle. The rectangle defines the ellipse from which the arc is drawn. + The starting angle of the arc, measured in degrees clockwise from the x-axis. + The angle between startAngle and the end of the arc. + + + + Adds a cubic Bezier curve to the current figure. + + The curve’s starting point. + The curve’s first control point. + The curve’s second control point. + The curve’s endpoint. + + + + Adds a cubic Bezier curve to the current figure. + + The x-coordinate of the curve’s starting point. + The y-coordinate of the curve’s starting point. + The x-coordinate of the curve’s first control point. + The y-coordinate of the curve’s first control point. + The x-coordinate of the curve’s second control point. + The y-coordinate of the curve’s second control point. + The x-coordinate of the curve’s ending point. + The y-coordinate of the curve’s ending point. + + + + Adds a sequence of connected cubic Bezier curves to the current figure. + + An list of points that define the curves. + + + + Adds a spline curve to the current figure. + + An array of points that define the curve. + Specifies the curve intensity. Values greater than 1 produce unpredictable results. + + + + Adds a spline curve to the current figure. + + An array of points that define the curve. + + + + Adds an ellipse to the current path. + + The rectangle within which the ellipse should be drawn. + + + + Adds an ellipse to the current path. + + The x-coordinate of the rectangle’s upper-left corner. The rectangle defines the ellipse. + The y-coordinate of the rectangle’s upper-left corner. The rectangle defines the ellipse. + The width of the rectangle that defines the ellipse. + The height of the rectangle that defines the ellipse. + + + + Appends a line segment to the figure. + + The line’s starting point. + The line’s endpoint. + + + + Appends a line segment to the figure. + + The x-coordinate of the line’s starting point. + The y-coordinate of the line’s starting point. + The x-coordinate of the line’s endpoint. + The y-coordinate of the line’s endpoint. + + + + Appends a line segment to the figure. + + An array of points that define line segments to add. + + + + Appends a sequence of lines and curves to this path. + + A path to add. + true if the first figure in the added path is a part of the last figure in this path; false if the first figure in the added path is separate from the last figure in this path. + + + + Adds the outline of a pie shape to this path. + + A bounding rectangle that defines the ellipse from which the pie is drawn. + The starting angle for the pie section, measured in degrees clockwise from the x-axis. + The angle between startAngle and the end of the pie section, measured in degrees clockwise from startAngle. + + + + Adds the outline of a pie shape to this path. + + The x-coordinate of the rectangle’s upper-left corner. The rectangle defines the pie shape bounds. + The y-coordinate of the rectangle’s upper-left corner. The rectangle defines the pie shape bounds. + The width of the pie shape’s bounding rectangle. + The height of the pie shape’s bounding rectangle. + The starting angle for the pie section, measured in degrees clockwise from the x-axis. + The angle between startAngle and the end of the pie section, measured in degrees clockwise from startAngle. + + + + Adds a polygon to the figure. + + A list of points that define the polygon. + + + + Adds a rectangle to a figure. + + The rectangle to add. + + + + Adds a series of rectangles to this path. + + A list of rectangles to add. + + + + Adds a text string to this path. + + A text to add. + An object that contains font information. + The staring point of the text. + An object that contains text formatting information (alignment, line spacing and so on). + + + + Adds a text string to this path. + + A text to add. + An object that contains font information. + An area where to draw a text string. + An object that contains text formatting information (alignment, line spacing and so on). + + + + Clones the DXGraphicsPath object. + + A copy of the DXGraphicsPath object. + + + + Closes the current figure and starts a new figure. If the current figure contains a sequence of connected lines and curves, the method closes the loop by connecting a line from the endpoint to the starting point. + + + + + Disposes of the DXGraphicsPath object. + + + + + Gets or sets how to fill the interiors of shapes in the GraphicsPath instance. + + An enumeration value that indicates the shape interior’s fill mode. + + + + Converts each curve in the path into a sequence of connected line segments. + + + + + Applies the specified transform and converts each curve in this GraphicsPath into a sequence of connected line segments. + + A matrix by which to transform this GraphicsPath before flattening. + Specifies the maximum permitted error between the curve and its flattened approximation. A value of 0.25 is the default. Reducing the flatness value will increase the number of line segments in the approximation. + + + + Applies the specified transform and converts each curve in the GraphicsPath into a sequence of connected line segments. + + A matrix by which to transform this GraphicsPath before flattening. + + + + Returns bounds of this GraphicsPath instance. + + A rectangle that bounds this GraphicsPath. + + + + Gets the last point in the PathPoints array. + + The last point in this path. + + + + Gets a path data (a list of points and types) for this GraphicsPath. + + An object that contains path data. + + + + Indicates whether the DXGraphicsPath instance contains the specified point. + + The point to test. + true if the DXGraphicsPath instance contains specified point; otherwise, false. + + + + Indicates whether the DXGraphicsPath instance contains the specified point. + + The x-coordinate of the point to test. + The y-coordinate of the point to test. + true if the DXGraphicsPath instance contains specified point; otherwise, false. + + + + Retrieves the path points. + + A list of points in the path. + + + + Gets the types of the points in the PathPoints list. + + A list of point types in the path. + + + + Gets the number of path points. + + The number of elements in the PathPoints or the PathTypes list. + + + + Reverts properties of the current object to default values. + + + + + Starts a new figure without closing the current figure. All subsequent points added to the path are added to this new figure. + + + + + Applies a transform matrix to this GraphicsPath. + + The transformation matrix to apply. + + + + Adds an additional outline to the DXGraphicsPath object. + + The width between the original outline of the path and the new outline this method creates. + A matrix that specifies a transform to apply to the path before widening. + + + + Adds an additional outline to the path. + + The width between the original outline of the path and the new outline this method creates. + + + + Contains graphical data + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + A list of points used to construct the path. + A list of point types. + An enumeration value that indicates the fill mode. + + + + Initializes a new instance of the class with specified settings. + + A list of points used to construct the path. + A list of point types. + + + + Clones the current DXGraphicsPathData object. + + A copy of the DXGraphicsPathData object. + + + + Obtains a fill mode of the path interior. + + An enumeration value that indicates how to fill and clip the interior of a closed figure. + + + + Returns the bounds of the DXGraphicsPathData instance. + + The DXGraphicsPathData bounds. + + + + Retrieves points used to construct the path. + + A list of points used to construct the path. + + + + Obtains types associated with the points in the path. + + A list of types associated with the points in the path. + + + + Lists values that indicate the measurement unit for the given data. + + + + + The measurement units of the display device. Typically pixels for video displays, and 1/100 inch for printers. + + + + + The document unit (1/300 inch). + + + + + The inch. + + + + + The millimeter. + + + + + The device pixel. + + + + + The printer’s point (1/72 inch). + + + + + The world coordinate system unit. + + + + + Enables you to convert values that are calculated in some measure units to different measure units. + + + + + Adjusts the document margins calculated for the specified unit of measure according to a new unit of measure. + + The size to convert. + The initial unit of measure. + The required unit of measure. + The conversion result. + + + + Adjusts the document margins calculated for the specified DPI according to a new DPI. + + A size to convert. + The initial DPI setting. + The required DPI setting. + The conversion result. + + + + Adjusts the integer value calculated for the specified DPI according to a new DPI. + + The value to convert. + The initial DPI setting. + The required DPI setting. + The conversion result. + + + + Adjusts the document margins calculated for the specified unit of measure according to a new unit of measure. + + The value to convert. + The initial unit of measure. + The required unit of measure. + The conversion result. + + + + Adjusts the float value calculated for the specified DPI according to a new DPI. + + The value to convert. + The initial DPI setting. + The required DPI setting. + The conversion result. + + + + A rectangular brush with a hatch style, a foreground color, and a background color. + + + + + Initializes a new instance of the class with specified settings. + + An enumeration value that indicates the the pattern that the hatch brush should draw. + The brush’s foreground color. + The brush’s background color. + + + + Obtains the background color of the brush. + + The brush’s background color. + + + + Clones the current DXHatchBrush instance. + + A copy of the current object. + + + + Determines whether the specified object is equal to the current DXHatchBrush object. + + An object to compare with the current DXHatchBrush object. + true if the specified object is equal to the current object; otherwise, false. + + + + Retrieves the foreground color of the brush. + + The brush’s foreground color. + + + + Returns the hash code for the current DXHatchBrush object. + + The hash code for the current object. + + + + Obtains the hatch style of a brush. + + An enumeration value that indicates the hatch style. + + + + Lists values that indicate patterns available for a hatch brush. + + + + + A pattern of lines on a diagonal from upper right to lower left edges. + + + + + Cross lines. + + + + + Diagonal lines that slant to the right from top points to bottom points are spaced 50 percent closer and twice the width of ForwardDiagonal. This hatch pattern is not antialiased. + + + + + Horizontal lines that are spaced 50 percent closer than Horizontal and twice the width of Horizontal. + + + + + Diagonal lines that slant to the left from top points to bottom points are spaced 50 percent closer and twice the width of BackwardDiagonal, but the lines are not antialiased. + + + + + Vertical lines that are spaced 50 percent closer than Vertical and twice its width. + + + + + Dashed diagonal lines that slant to the right from top points to bottom points. + + + + + Dashed horizontal lines. + + + + + Dashed diagonal lines that slant to the left from top points to bottom points. + + + + + Dashed vertical lines. + + + + + Layered bricks that slant to the left from top points to bottom points. + + + + + Crisscross diagonal lines. + + + + + Divot pattern. + + + + + Forward diagonal and backward diagonal crosses lines, each of which is composed of dots. + + + + + Horizontal and vertical crossed lines, each of which is composed of dots. + + + + + A pattern of lines on a diagonal from upper left to lower right. + + + + + A pattern of horizontal lines. + + + + + Horizontally layered bricks. + + + + + A checkerboard with squares that are twice the size of SmallCheckerBoard. + + + + + A confetti composed of larger pieces than SmallConfetti. + + + + + Crosses lines pattern. + + + + + Diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than ForwardDiagonal, but are not antialiased. + + + + + Horizontal lines that are spaced 50 percent closer together than Horizontal. + + + + + Diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased. + + + + + Vertical lines that are spaced 50 percent closer together than Vertical. + + + + + Specifies the LargeGrid hatch style. + + + + + Specifies the Horizontal hatch style. + + + + + Horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal). + + + + + Vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical). + + + + + Forward diagonal and backward diagonal lines that cross but are not antialiased. + + + + + A 5-percent hatch. The ratio of foreground color to background color is 5:95. + + + + + A 10-percent hatch. The ratio of foreground color to background color is 10:90 + + + + + A 20-percent hatch. The ratio of foreground color to background color is 20:80. + + + + + A 25-percent hatch. The ratio of foreground color to background color is 25:75. + + + + + A 30-percent hatch. The ratio of foreground color to background color is 30:70. + + + + + A 40-percent hatch. The ratio of foreground color to background color is 40:60. + + + + + A 50-percent hatch. The ratio of foreground color to background color is 50:50. + + + + + A 60-percent hatch. The ratio of foreground color to background color is 60:40. + + + + + A 70-percent hatch. The ratio of foreground color to background color is 70:30. + + + + + A 75-percent hatch. The ratio of foreground color to background color is 75:25. + + + + + A 80-percent hatch. The ratio of foreground color to background color is 80:100. + + + + + A 90-percent hatch. The ratio of foreground color to background color is 90:10. + + + + + A plaid material pattern. + + + + + Diagonally layered shingles that slant to the right from top points to bottom points. + + + + + A checkerboard pattern. + + + + + A confetti pattern. + + + + + Horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross. + + + + + A diagonally placed checkerboard. + + + + + Spheres laid adjacent to one another. + + + + + Trellis pattern. + + + + + A pattern of vertical lines. + + + + + Horizontal lines that are composed of tildes. + + + + + A woven material pattern. + + + + + Diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased. + + + + + Diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased. + + + + + Horizontal lines that are composed of zigzags. + + + + + Lists values that indicate the display mode of the hotkey prefixes. + + + + + Do not display the hotkey prefix. + + + + + No hotkey prefix. + + + + + Display the hot-key prefix. + + + + + An abstract class that contains settings for images. + + + + + Creates a copy of the instance. + + The copy of the instance. + + + + Releases all resources used by the object. + + + + + Determines whether the specified object is equal to the current DXImage instance. + + A DXImage object to test. + true if the DXImage parameter has the same property values as the current DXImage instance; otherwise, false. + + + + Creates an image from the specified binary string that contains the image data. + + A binary string that contains image data. + The created image. + + + + Creates an image from the specified stream that contains the image data. + + A stream that contains data for the image. + The created image. + + + + Gets the height of the image in pixels. + + The height of the image in pixels. + + + + Gets the horizontal resolution of the image in pixels per inch. + + The horizontal resolution of the image in pixels per inch. + + + + Gets the image format. + + The image format. + + + + Rotates and flips an image. + + An enumeration value that indicates the rotation and flip type. + + + + Saves the image to the specified stream in the specified format. + + A object to which the image is saved. + The specified format for the image. + + + + Saves the image to the specified file in the specified format. + + The name of the file to which the image is saved. + The specified format for the image. + + + + Gets the width and height of the image in pixels. + + The width and height of the image in pixels. + + + + Gets the vertical resolution of the image in pixels per inch. + + The vertical resolution of the image in pixels. + + + + Gets the width of the image in pixels. + + The width of the image in pixels. + + + + Specifies the image format. + + + + + Initializes a new instance of the class. + + + + + Gets the bitmap (BMP) image format. + + An object that indicates the bitmap image format. + + + + Gets the enhanced metafile (EMF) image format. Currently not supported. + + An object that indicates the enhanced metafile image format. + + + + Gets the Graphics Interchange Format (GIF) image format. + + An object that indicates the GIF image format. + + + + Gets the Windows icon (.ico) image format. + + An object that indicates the Windows icon image format. + + + + Gets the Joint Photographic Experts Group (JPEG) image format. + + An object that indicates the JPEG image format. + + + + Gets the W3C Portable Network Graphics (PNG) image format. + + An object that indicates the PNG image format. + + + + Gets the Tagged Image File Format (TIFF) image format. + + An object that indicates the TIFF image format. + + + + Converts this DXImageFormat object to a string. + + A string that is this DXImageFormat object. + + + + Gets the unknown image format. + + An object that indicates the unknown image format. + + + + Gets the Windows metafile (WMF) image format. Currently not supported. + + An object that indicates the Windows metafile image format. + + + + Lists values that indicate the algorithm used when images are scaled or rotated. + + + + + Bicubic interpolation. No pre-filter. This mode is not suitable for shrinking an image below 25 percent of its original size. + + + + + Bilinear interpolation. No pre-filter. This mode is not suitable for shrinking an image below 50 percent of its original size. + + + + + Default mode. + + + + + High quality interpolation. + + + + + High-quality bicubic interpolation. Pre-filter is applied to ensure high-quality shrinking. This mode produces the highest quality transformed images. + + + + + High-quality, bilinear interpolation. Pre-filter is applied to ensure high-quality shrinking. + + + + + Invalid mode. + + + + + Low quality interpolation. + + + + + Nearest-neighbor interpolation. + + + + + A brush that paints an area with a linear gradient. + + + + + Initializes a new instance of the class with specified settings. + + The starting point of the linear gradient. + The ending point of the linear gradient. + The starting color of the gradient. + The ending color of the gradient. + + + + Initializes a new instance of the class with specified settings. + + The bounds of the linear gradient. + The starting color of the gradient. + The ending color of the gradient. + An enumeration value that specifies the orientation of the gradient. + + + + Initializes a new instance of the class with specified settings. + + The bounds of the linear gradient. + The starting color of the gradient. + The ending color of the gradient. + The angle of the gradient’s orientation line, measured in degrees clockwise from the x-axis. + true if the angle is affected by the transformation matrix associated with this DXLinearGradientBrush; otherwise, false. + + + + Initializes a new instance of the class with specified settings. + + The bounds of the linear gradient. + The starting color of the gradient. + The ending color of the gradient. + + + + Gets or sets a custom falloff of the gradient. + + An object that contains arrays of blend factors and positions. + + + + Clones the current DXLinearGradientBrush object. + + A copy of the DXLinearGradientBrush object. + + + + Determines whether the specified object is equal to the current DXLinearGradientBrush object. + + An object to compare with the current DXLinearGradientBrush object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns the hash code for the current DXLinearGradientBrush object. + + The hash code for the current object. + + + + Gets or sets a multicolor linear gradient. + + An object that defines a multicolor linear gradient. + + + + Gets or sets the starting and ending colors of the gradient. + + An array of two Color structures that represents the starting and ending colors of the gradient. + + + + Gets or sets a rectangular region that defines the starting and ending points of the gradient. + + A structure that specifies the starting and ending points of the gradient. + + + + Creates a linear gradient with a center color and a linear falloff to a single color on both ends. + + A value (from 0 through 1) that specifies the point where the gradient is composed of only the ending color. + A value (from 0 through 1) that specifies how fast the colors falloff from the starting color to focus (ending color) + + + + Creates a linear gradient with a center color and a linear falloff to a single color on both ends. + + A value (from 0 through 1) that specifies the point where the gradient is composed of only the ending color. + + + + Lists values that indicate the direction of a linear gradient. + + + + + A gradient from upper right to lower left. + + + + + A gradient from upper left to lower right. + + + + + A gradient from left to right. + + + + + A gradient from top to bottom. + + + + + Lists values that indicate available cap styles for a DXPen instance. + + + + + A mask used to check whether a line cap is an anchor cap. + + + + + An arrow-shaped anchor cap. + + + + + A custom line cap. + + + + + A diamond anchor cap. + + + + + A flat line cap. + + + + + No cap. + + + + + A round line cap. + + + + + A round anchor cap. + + + + + A square line cap. + + + + + A square anchor line cap. + + + + + A triangular line cap. + + + + + Lists values that indicate how to join consecutive line or curve segments in a figure. + + + + + Specifies a beveled join. The join results in a diagonal corner. + + + + + Specifies a mitered join. The join results in a sharp corner or a clipped corner, depending on whether the length of the miter exceeds the miter limit. + + + + + Specifies a mitered join. The join results in a sharp corner or a beveled corner, depending on whether the length of the miter exceeds the miter limit. + + + + + Specifies a circular join. The join results in a smooth, circular arc between the lines. + + + + + Specifies the dimensions of the margins of a printed page. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The left margin. + The right margin. + The top margin. + The bottom margin. + + + + Gets or sets the bottom margin. + + The bottom margin. + + + + Clones the current DXMargins object. + + A copy of the current DXMargins object. + + + + Determines whether the specified object is equal to the current DXMargins instance. + + An object to compare. + true if the other parameter has the same property values as the current DXMargins instance; otherwise, false. + + + + Determines whether the specified object is equal to the current DXMargins instance. + + An object to compare. + true if the object parameter has the same property values as the current DXMargins instance; otherwise, false. + + + + Gets the hash code for the DXMargins object. + + The hash code. + + + + Gets or sets the left margin. + + The left margin. + + + + Gets or sets the right margin. + + The right margin. + + + + Gets or sets the top margin. + + The top margin. + + + + Returns a string that specifies `DXMargins’. + + A string that specifies DXMargins. + + + + Encapsulates a 3x2 affine matrix used for geometric transformations. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified elements. + + The value in the first row and first column. + The value in the first row and second column. + The value in the second row and first column. + The value in the second row and second column. + The value in the third row and first column. + The value in the third row and second column. + + + + Initializes a new instance of the class with specified settings. + + An array of floating-point values that are the matrix elements. + + + + Obtains the value in the first row and first column. + + The value in the first row and first column. + + + + Obtains the value in the first row and second column. + + The value in the first row and second column. + + + + Obtains the value in the second row and first column. + + The value in the second row and first column. + + + + Clones the DXMatrix object. + + A copy of the DXMatrix object. + + + + Creates a new matrix based on the current matrix and applies a clockwise rotation of the specified angle relative to the matrix origin. + + Angle of rotation in degrees.’ + The resulting transformation matrix. + + + + Creates a new matrix based on the current matrix and applies the specified scale vector. + + The value by which to scale in the x-axis direction. + The value by which to scale in the y-axis direction. + The resulting transformation matrix. + + + + Creates a new matrix based on the current matrix and applies the specified shear vector. + + The horizontal shear factor. + The vertical shear factor. + The resulting transformation matrix. + + + + Creates a new matrix based on the current matrix and translates the coordinate system origin to the specified offset. + + The x-coordinate of the translation. + The y-coordinate of the translation. + The resulting transformation matrix. + + + + Obtains the value in the second row and second column. + + The value in the second row and second column. + + + + Obtains the value in the third row and first column. + + The value in the third row and first column. + + + + Obtains the matrix elements.’ + + An array of matrix elements. + + + + Determines whether the specified object is equal to the current DXMatrix object. + + A DXFont to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether the specified object is equal to the current DXMatrix object. + + An object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Obtains the value in the third row and second column. + + The value in the third row and second column. + + + + Returns the hash code for the current DXFont object. + + The hash code for the current object. + + + + Inverts the DXMatrix instance (if it is invertible). + + + + + Gets whether this DXMatrix is the identity matrix. + + true if the DXMatrix instance is the identity matrix; otherwise, false. + + + + Gets whether the DXMatrix object is invertible. + + true if the object is invertible; otherwise, false. + + + + Multiplies this DXMatrix by the specified matrix, and in the order specified in the order parameter. + + The matrix by which this DXMatrix is to be multiplied. + An enumeration value that indicates the order of the multiplication. + + + + Gets the x translation value (the dx value, or the element in the third row and first column). + + The x translation value. + + + + Gets the y translation value (the dy value, or the element in the third row and second column). + + The y translation value. + + + + Reverts the current object properties to default values. + + + + + Applies a clockwise rotation to the specified angle around the origin (zero x and y coordinates). + + The angle (extent) of the rotation, in degrees. + An enumeration value that indicates the order (append or prepend) in which the rotation is applied. + + + + Applies a clockwise rotation around the specified point in the specified order. + + The angle of the rotation, in degrees. + The rotation center. + An enumeration value that indicates the order (append or prepend) in which the rotation is applied. + + + + Prepends and applies the specified scale vector to the DXMatrix instance. + + The value by which to scale DXMatrix in the x-axis direction. + The value by which to scale DXMatrix in the y-axis direction. + An enumeration value that indicates the order (append or prepend) in which the scale vector is applied to this DXMatrix. + + + + Prepends and applies the specified shear vector to the DXMatrix instance. + + The horizontal shear factor. + The vertical shear factor. + An enumeration value that indicates the order (append or prepend) in which the shear is applied. + + + + Applies the geometric transformation to a point. + + A point to transform. + The transformed point. + + + + Applies the geometric transformation to an array of points. + + The points to transform. + The transformed points. + + + + Applies the geometric transformation to an array of points. + + The points to transform. + + + + Applies the specified translation vector to DXMatrix in the specified order. + + The x-coordinate of the translation. + The y-coordinate of the translation. + An enumeration value that indicates the order (append or prepend) in which the translation is applied. + + + + Lists values that indicate the order for matrix transformation operations. + + + + + The new operation is applied after the old operation. + + + + + The new operation is applied before the old operation. + + + + + A brush that fills the interior of a DXGraphicsPath object with a gradient. + + + + + Initializes a new instance of the class with specified settings. + + An object that defines the area which this PathGradientBrush should fill. + + + + Initializes a new instance of the class with specified settings. + + The base gradient brush. + + + + Gets or sets a custom falloff for the gradient. + + The custom falloff. + + + + Gets or sets the color at the center of the path gradient. + + The color at the center of the path gradient. + + + + Gets or sets the center point of the path gradient. + + The center point of the path gradient. + + + + Clones the current DXPathGradientBrush object. + + A copy of the current DXPathGradientBrush object. + + + + Determines whether the specified object is equal to the current DXPathGradientBrush object. + + An object to compare with the current DXPathGradientBrush object. + true if the specified object is equal to the current object; otherwise, false. + + + + Gets or sets the focus point for the gradient falloff. + + The focus point for the gradient falloff. + + + + Returns the hash code for the current DXPathGradientBrush object. + + The hash code for the current object. + + + + Gets or sets a multicolor linear gradient. + + An object defines a multicolor linear gradient. + + + + Obtains path data associated with the brush. + + An object that contains graphical data. + + + + Gets or sets an array of colors that correspond to the points in the path the PathGradientBrush fills. + + An array of colors associated with each point in the path. + + + + List types of points available for the DXGraphicsPath instance. + + + + + A Bezier curve. + + + + + The endpoint of a subpath. + + + + + A line segment. + + + + + A mask point. + + + + + The starting point of a DXGraphicsPath object. + + + + + Defines an object used to draw lines and curves. + + + + + Initializes a new instance of the class with specified settings. + + A brush that defines the pen parameters. + The pen width. + + + + Initializes a new instance of the class with specified settings. + + A brush that defines the pen parameters. + + + + Initializes a new instance of the class with specified settings. + + The pen color. + The pen width. + An enumeration value that indicates the cap style applied to line ends. + + + + Initializes a new instance of the class with specified settings. + + The pen color. + The pen width. + + + + Initializes a new instance of the class with specified settings. + + The pen color. + + + + Gets or sets the brush that determines the pen attributes. + + A brush that determines the pen attributes. + + + + Clones the current DXPen object. + + A copy of the current DXPen object. + + + + Gets the pen color. + + The pen color. + + + + Gets or sets a custom cap to use at the line end. + + An object the contains end cap settings. + + + + Gets or sets a custom cap to use at the line start. + + An object the contains end cap settings. + + + + Gets or sets the cap style used at the dash end. + + An object that contains the dash style parameters. + + + + Gets or sets the distance between the start of a line to the start of a dash pattern. + + The distance between the start of a line to the beginning of a dash pattern. + + + + Gets or sets an array of custom dashes and spaces. + + An array of real numbers that specifies the lengths of alternating dashes and spaces in dashed lines. + + + + Gets or sets the style applied to dashed lines. + + An enumeration value that indicates the dash style. + + + + Disposes of the DXPen instance. + + + + + Gets or sets the cap style applied to the end of lines. + + The cap style applied to line ends. + + + + Determines whether the specified DXPen object is equal to the current DXPen instance. + + An object to compare. + true if the other parameter is DXPen and has the same property values as the current DXPen instance; otherwise, false. + + + + Determines whether the specified object is equal to the current DXPen instance. + + An object to compare. + true if the obj parameter has the same property values as the current DXPen instance; otherwise, false. + + + + Gets the hash code for the DXPen. + + The hash code. + + + + Gets or sets the join style for the ends of two consecutive lines. + + An enumeration value that indicates the join style. + + + + Gets or sets the limit of the thickness of the join on a mitered corner. + + The limit of the thickness of the join on a mitered corner. + + + + Obtains the type of lines the DXPen draws. + + An enumeration value that indicates the pen type. + + + + Gets or sets the cap style applied to the line start. + + An enumeration value that indicate the start cap style. + + + + Gets or sets the width of the pen. + + The pen width, measured in units specified by the DXGraphics.PageUnit property. + + + + Lists values that indicate the pen type. + + + + + The pen uses a hatch fill to fill lines. + + + + + The pen uses a linear gradient fill to fill lines. + + + + + The pen uses a path gradient fill to fill lines. + + + + + The pen uses a solid color to fill lines. + + + + + The pen uses a bitmap texture fill to fill lines. + + + + + Describes the interior of a graphics shape composed of rectangles and paths. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + A DXGraphicsPath instance that defines a new region. + + + + Initializes a new instance of the class with specified settings. + + A rectangle that defines an area of a new region. + + + + Clones the current DXRegion object. + + A copy of the current DXRegion object. + + + + Updates the region to contain the portion of the specified DXgraphicsPath that does not intersect with the current region. + + A DXGraphicsPath instance to complement with the current region. + + + + Updates the region to contain the portion of the specified DXRegion that does not intersect with the current region. + + A region to complement with the current region. + + + + Updates the region to contain the portion of the specified rectangle that does not intersect with the current region. + + A rectangle to complement with the current region. + + + + Disposes of the DXRegion object. + + + + + Excludes the specified DXGraphicsPath instance from the region. + + An object to exclude from the region. + + + + Excludes the specified region from the current region. + + A region to exclude from the current region. + + + + Excludes the specified rectangle from the region. + + A rectangle to exclude from the current region. + + + + Obtains the region bounds. + + The region bounds. + + + + Assigns the clip region to the intersection of the current region and the specified DXGraphicsPath instance. + + An object that intersects the current region. + + + + Assigns the clip region to the intersection of the current region and the specified region. + + A region that intersects with the current region. + + + + Assigns the clip region to the intersection of the current region and the specified rectangle. + + A structure that intersects the current region. + + + + Gets or sets whether the current region contains the specified point. + + A point to check. + true if the region contains the point; otherwise, false. + + + + Gets or sets whether the current region contains the specified rectangle. + + A rectangle to check. + true if the region contains the rectangle; otherwise, false. + + + + Initializes the region to an empty interior. + + + + + Initializes the region to an infinite interior. + + + + + Transforms the region by the specified transformation matrix. + + The matrix by which to transform the region. + + + + Updates the region to the union of itself and the specified DXGraphicsPath instance. + + The object to unite with the region. + + + + Updates the region to the union of itself and the specified DXRegion object. + + The region to unite with the current region. + + + + Updates the region to the union of itself and the specified RectangleF structure. + + An object to unite with the current region. + + + + Updates the region to include the union minus the intersection of itself with the specified DXGraphicsPath object. + + The DXGraphicsPath object to use in a XOR (Exclusive OR) operation with the current region. + + + + Updates this region to the union minus the intersection of itself with the specified region. + + The region to use in a XOR (Exclusive OR) operation with the current region. + + + + Updates the region to include the union minus the intersection of itself with the specified rectangle. + + The rectangle to use in a XOR (Exclusive OR) operation with the current region. + + + + Lists values that indicate the rotation and flip type. + + + + + A 180-degree clockwise rotation without flipping. + + + + + A 180-degree clockwise rotation followed by a horizontal flip. + + + + + A 180-degree clockwise rotation followed by a horizontal and vertical flip. + + + + + A 180-degree clockwise rotation followed by a vertical flip. + + + + + A 270-degree clockwise rotation without flipping. + + + + + A 270-degree clockwise rotation followed by a horizontal flip. + + + + + A 270-degree clockwise rotation followed by a horizontal and vertical flip. + + + + + A 270-degree clockwise rotation followed by a vertical flip. + + + + + A 90-degree clockwise rotation without flipping. + + + + + A 90-degree clockwise rotation followed by a horizontal flip. + + + + + A 90-degree clockwise rotation followed by a horizontal and vertical flip. + + + + + A 90-degree clockwise rotation followed by a vertical flip. + + + + + No clockwise rotation and no flipping. + + + + + No clockwise rotation followed by a horizontal flip. + + + + + No clockwise rotation followed by a horizontal and vertical flip. + + + + + No clockwise rotation followed by a vertical flip. + + + + + Lists values that indicate smoothing (antialiasing) mode applied to lines and curves and the edges of filled areas. + + + + + Specifies antialiased rendering. + + + + + Specifies no antialiasing. + + + + + Specifies antialiased rendering. + + + + + Specifies no antialising. + + + + + Specifies an invalid mode. + + + + + Specifies no antialising. + + + + + A single-color brush. + + + + + Initializes a new instance of the class with specified settings. + + The brush color. + + + + Clones the current DXSolidBrush object. + + A copy of the DXSolidBrush object. + + + + Gets or sets the color of the brush. + + The brush color. + + + + Determines whether the specified object is equal to the current DXFont object. + + A DXFont to compare with current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns the hash code for the current DXFont object. + + The hash code for the current object. + + + + Lists values that indicate the type of alignment of a text string relative to its layout rectangle. + + + + + Text is aligned in the center of the layout rectangle. + + + + + The text is aligned far from the original position of the layout rectangle. + + + + + The text is aligned near the layout. + + + + + Contains text layout information, display manipulations, and OpenType features. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from the existing instance. + + An object from which the new DXStringFormat object should be initialized. + + + + Gets or sets the horizontal string alignment. + + An enumeration value that specifies the horizontal alignment of the string. + + + + Clones the DXStringFormat object. + + A copy of the DXStringFormat object. + + + + Creates a generic default DXStringFormat object. + + An object with generic default settings. + + + + Creates a generic typographic DXStringFormat object. + + An object with generic typographic settings. + + + + Determines whether the specified object is equal to the current DXStringFormat object. + + A DXStringFormat object to compare with current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether the specified object is equal to the current DXStringFormat object. + + An object to compare with current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Gets or sets formatting information flags. + + An enumeration value that indicates formatting information. + + + + Returns the hash code for the current DXStringFormat object. + + The hash code. + + + + Gets or sets the type of display for hotkey prefixes that relate to text. + + An enumeration value that indicates the hotkey prefix display type. + + + + Gets or sets the string’s vertical alignment.’ + + An enumeration value that indicates the vertical line alignment. + + + + Gets or sets tab stops for the DXStringFormat object. + + The number of spaces between the beginning of a text line and the first tab stop. + + + + Gets or sets how trim text when it exceeds the edges of the layout rectangle. + + An enumeration value that indicates how to trim characters from a string that does not fit into a layout shape. + + + + Specifies the display and layout information for text strings. + + + + + Text has the right-to-left text direction. + + + + + Text is vertically aligned. + + + + + Control characters such as the left-to-right mark are shown in the output with a glyph. + + + + + Parts of characters are allowed to overhang the string’s layout rectangle. + + + + + Only entire lines are laid out in the formatting rectangle. + + + + + Includes the trailing space at the end of each line. + + + + + Overhanging glyph parts and unwrapped text reaching outside the formatting rectangle are allowed to be displayed. + + + + + Fallback to alternate fonts for characters not supported in the requested font is disabled. Any missing characters are displayed with the font missing glyph, usually an open square. + + + + + Text wrapping between lines is disabled. This flag is implied when a point is passed instead of a rectangle, or when the specified text rectangle has a zero line length. + + + + + Lists values that indicate how to trim characters from a string that does not completely fit into a layout shape. + + + + + The text is trimmed to the nearest character. + + + + + The text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line. + + + + + The center is removed from trimmed lines and replaced by an ellipsis. The algorithm keeps as much of the last slash-delimited segment of the line as possible. + + + + + The text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line. + + + + + No trimming is specified. + + + + + The text is trimmed to the nearest word. + + + + + Lists values that indicate the quality of text rendering. + + + + + An antialiased glyph bitmap without hinting is used to draw each character. Better quality due to antialiasing. Stem width differences may be noticeable because hinting is turned off. + + + + + An antialiased glyph bitmap with hinting is used to draw each character. Much better quality due to antialiasing, but at a higher performance cost. + + + + + A glyph ClearType bitmap with hinting is used to draw each character. The highest quality setting. Used to take advantage of ClearType font features. + + + + + A glyph bitmap is used to draw each character. Hinting is not used. + + + + + A glyph bitmap is used to draw each character. Hinting is used to improve character appearance on stems and curvatures. + + + + + A glyph bitmap with system default rendering hint is used to draw each character. The text is drawn using font-smoothing settings the user has selected for the system. + + + + + A brush that uses an image to fill a shape interior. + + + + + Initializes a new instance of the class with specified settings. + + An image used in the brush. + An enumeration value that indicates how shapes are filled + + + + Clones the current DXTextureBrush instance. + + A copy of the current DXTextureBrush instance. + + + + Disposes of the DXTextureBrush object. + + + + + Determines whether the specified object is equal to the current DXTextureBrush instance. + + An object to test. + true if the obj parameter has the same property values as the current DXTextureBrush instance; otherwise, false. + + + + Returns the hash code for the current DXHatchBrush object. + + The hash code for the current object. + + + + Obtains an image used in the brush. + + An image with which the brush fills shapes. + + + + Base class for pattern brushes. + + + + + Determines whether the specified object is equal to the current DXTilingBrush instance. + + An object to test. + true if the object parameter has the same property values as the current DXTilingBrush instance; otherwise, false. + + + + Gets the hash code for DXTilingBrush. + + The hash code. + + + + Gets or sets a copy of the geometric world transformation. + + A copy of the DXMatrix that is the geometric world transformation. + + + + Gets or sets the brush’s wrap mode. + + An enumeration value that indicates the wrap mode. + + + + Lists values that indicate how to lite a texture or gradient it is smaller than the area being filled. + + + + + The texture or gradient is not tiled. + + + + + Tiles the gradient or texture. + + + + + Reverses the texture or gradient horizontally and then tiles the texture or gradient. + + + + + Reverses the texture or gradient horizontally and vertically and then tiles the texture or gradient. + + + + + Reverses the texture or gradient vertically and then tiles the texture or gradient. + + + + + Contains extension members for the DevExpress.Drawing library. + + + + + Contains extension methods for the class. + + + + + Converts a DXGraphicsUnit object to a DPI number. + + An enumeration value that indicates the unit type. + The DPI number. + + + + Converts a DXGraphicsUnit object to a DPI number using the device-independent Pixel constant. + + An enumeration value to convert. + The DPI number. + + + + Contains extension methods for the class. + + + + + Converts a DXImage object to the Image object. + + The object to convert. + The resulting image. + + + + Contains cross-platform counterparts of the System.Drawing.Printing classes not supported in non-Windows environments. + + + + + Specifies standard paper sizes. + + + + + A2 paper (420 mm by 594 mm). + + + + + A3 paper (297 mm by 420 mm). + + + + + A3 extra paper (322 mm by 445 mm). + + + + + A3 extra transverse paper (322 mm by 445 mm). + + + + + A3 rotated paper (420 mm by 297 mm). + + + + + A3 transverse paper (297 mm by 420 mm). + + + + + A4 paper (210 mm by 297 mm). + + + + + A4 extra paper (236 mm by 322 mm). This value is specific to the PostScript driver and is used only by Linotronic printers to help save paper. + + + + + A4 plus paper (210 mm by 330 mm). + + + + + A4 rotated paper (297 mm by 210 mm). Requires Windows NT 4.0 or later. + + + + + A4 small paper (210 mm by 297 mm). + + + + + A4 transverse paper (210 mm by 297 mm). + + + + + A5 paper (148 mm by 210 mm). + + + + + A5 extra paper (174 mm by 235 mm). + + + + + A5 rotated paper (210 mm by 148 mm). + + + + + A5 transverse paper (148 mm by 210 mm). + + + + + A6 paper (105 mm by 148 mm). Requires Windows NT 4.0 or later. + + + + + A6 rotated paper (148 mm by 105 mm). Requires Windows NT 4.0 or later. + + + + + SuperA/SuperA/A4 paper (227 mm by 356 mm). + + + + + B4 paper (250 mm by 353 mm). + + + + + B4 envelope (250 mm by 353 mm). + + + + + JIS B4 rotated paper (364 mm by 257 mm). Requires Windows NT 4.0 or later. + + + + + B5 paper (176 mm by 250 mm). + + + + + B5 envelope (176 mm by 250 mm). + + + + + ISO B5 extra paper (201 mm by 276 mm). + + + + + JIS B5 rotated paper (257 mm by 182 mm). Requires Windows NT 4.0 or later. + + + + + JIS B5 transverse paper (182 mm by 257 mm). + + + + + B6 envelope (176 mm by 125 mm). + + + + + JIS B6 paper (128 mm by 182 mm). Requires Windows NT 4.0 or later. + + + + + JIS B6 rotated paper (182 mm by 128 mm). Requires Windows NT 4.0 or later. + + + + + SuperB/SuperB/A3 paper (305 mm by 487 mm). + + + + + C3 envelope (324 mm by 458 mm). + + + + + C4 envelope (229 mm by 324 mm). + + + + + C5 envelope (162 mm by 229 mm).s + + + + + C6 envelope (114 mm by 162 mm). + + + + + C65 envelope (114 mm by 229 mm). + + + + + C paper (17 in. by 22 in.). + + + + + The paper size is defined by the user. + + + + + DL envelope (110 mm by 220 mm). + + + + + D paper (22 in. by 34 in.). + + + + + E paper (34 in. by 44 in.). + + + + + Executive paper (7.25 in. by 10.5 in.). + + + + + Folio paper (8.5 in. by 13 in.). + + + + + German legal fanfold (8.5 in. by 13 in.). + + + + + German standard fanfold (8.5 in. by 12 in.). + + + + + Invitation envelope (220 mm by 220 mm). + + + + + ISO B4 (250 mm by 353 mm). + + + + + Italy envelope (110 mm by 230 mm). + + + + + Japanese double postcard (200 mm by 148 mm). Requires Windows NT 4.0 or later. + + + + + Japanese rotated double postcard (148 mm by 200 mm). Requires Windows NT 4.0 or later. + + + + + Japanese Chou #3 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese rotated Chou #3 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese Chou #4 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese rotated Chou #4 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese Kaku #2 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese rotated Kaku #2 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese Kaku #3 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese rotated Kaku #3 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese You #4 envelope. Requires Windows NT 4.0 or later. + + + + + Japanese You #4 rotated envelope. Requires Windows NT 4.0 or later. + + + + + Japanese postcard (100 mm by 148 mm). + + + + + Japanese rotated postcard (148 mm by 100 mm). Requires Windows NT 4.0 or later. + + + + + Ledger paper (17 in. by 11 in.). + + + + + Legal paper (8.5 in. by 14 in.). + + + + + Legal extra paper (9.275 in. by 15 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper. + + + + + Letter paper (8.5 in. by 11 in.). + + + + + Letter extra paper (9.275 in. by 12 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper. + + + + + Letter extra transverse paper (9.275 in. by 12 in.). + + + + + Letter plus paper (8.5 in. by 12.69 in.). + + + + + Letter rotated paper (11 in. by 8.5 in.). + + + + + Letter small paper (8.5 in. by 11 in.). + + + + + Letter transverse paper (8.275 in. by 11 in.). + + + + + Monarch envelope (3.875 in. by 7.5 in.). + + + + + Note paper (8.5 in. by 11 in.). + + + + + #10 envelope (4.125 in. by 9.5 in.). + + + + + #11 envelope (4.5 in. by 10.375 in.). + + + + + #12 envelope (4.75 in. by 11 in.). + + + + + #14 envelope (5 in. by 11.5 in.). + + + + + #9 envelope (3.875 in. by 8.875 in.). + + + + + 6 3/4 envelope (3.625 in. by 6.5 in.). + + + + + 16K paper (146 mm by 215 mm). Requires Windows NT 4.0 or later. + + + + + 16K rotated paper (146 mm by 215 mm). Requires Windows NT 4.0 or later. + + + + + 32K paper (97 mm by 151 mm). Requires Windows NT 4.0 or later. + + + + + 32K big paper (97 mm by 151 mm). Requires Windows NT 4.0 or later. + + + + + 32K big rotated paper (97 mm by 151 mm). Requires Windows NT 4.0 or later. + + + + + 32K rotated paper (97 mm by 151 mm). Requires Windows NT 4.0 or later. + + + + + #1 rotated envelope (165 mm by 102 mm). Requires Windows NT 4.0 or later. + + + + + #10 envelope (324 mm by 458 mm). Requires Windows NT 4.0 or later. + + + + + #10 rotated envelope (458 mm by 324 mm). Requires Windows NT 4.0 or later. + + + + + #1 rotated envelope (165 mm by 102 mm). Requires Windows NT 4.0 or later. + + + + + #2 envelope (102 mm by 176 mm). Requires Windows NT 4.0 or later. + + + + + #2 rotated envelope (176 mm by 102 mm). Requires Windows NT 4.0 or later. + + + + + #3 envelope (125 mm by 176 mm). Requires Windows NT 4.0 or later. + + + + + #3 rotated envelope (176 mm by 125 mm). Requires Windows NT 4.0 or later. + + + + + #4 envelope (110 mm by 208 mm). Requires Windows NT 4.0 or later. + + + + + #4 rotated envelope (208 mm by 110 mm). Requires Windows NT 4.0 or later. + + + + + #5 envelope (110 mm by 220 mm). Requires Windows NT 4.0 or later. + + + + + Envelope #5 rotated envelope (220 mm by 110 mm). Requires Windows NT 4.0 or later. + + + + + #6 envelope (120 mm by 230 mm). Requires Windows NT 4.0 or later. + + + + + #6 rotated envelope (230 mm by 120 mm). Requires Windows NT 4.0 or later. + + + + + #7 envelope (160 mm by 230 mm). Requires Windows NT 4.0 or later. + + + + + #7 rotated envelope (230 mm by 160 mm). Requires Windows NT 4.0 or later. + + + + + #8 envelope (120 mm by 309 mm). Requires Windows NT 4.0 or later. + + + + + #8 rotated envelope (309 mm by 120 mm). Requires Windows NT 4.0 or later. + + + + + #9 envelope (229 mm by 324 mm). Requires Windows NT 4.0 or later. + + + + + #9 rotated envelope (324 mm by 229 mm). Requires Windows NT 4.0 or later. + + + + + Quarto paper (215 mm by 275 mm). + + + + + Standard paper (10 in. by 11 in.). + + + + + Standard paper (10 in. by 14 in.). + + + + + Standard paper (11 in. by 17 in.). + + + + + Standard paper (12 in. by 11 in.). Requires Windows NT 4.0 or later. + + + + + Standard paper (15 in. by 11 in.). + + + + + Standard paper (9 in. by 11 in.). + + + + + Statement paper (5.5 in. by 8.5 in.). + + + + + Tabloid paper (11 in. by 17 in.). + + + + + Tabloid extra paper (11.69 in. by 18 in.). This value is specific to the PostScript driver and is used only by Linotronic printers in order to conserve paper. + + + + + US standard fanfold (14.875 in. by 11 in.). + + + + + Defines a paper size. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + the name of the paper. + The width of the paper, in hundredths of an inch. + The height of the paper, in hundredths of an inch. + + + + Gets or sets the paper height. + + The height of the paper, in hundredths of an inch. + + + + Gets the type of paper. + + An enumeration value that indicates the paper type. + + + + Gets or sets the paper name. + + The name of the paper. + + + + Returns a string that specifies `DXPaperSize’. + + A string that specifies `DXPaperSize’. + + + + Gets or sets the paper width. + + The width of the paper, in hundredths of an inch. + + + + Provides an API that supports vector images. + + + + + A raster image created from a vector icon. + + + + + Creates a new instance of the class from the specified vector image. + + A vector image. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + true to dispose the images; otherwise, false. + + + + Creates a new SvgBitmap object from the specified vector image. + + The vector image. + The SvgBitmap object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The image size. + The SvgBitmap object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the image offset. + + A System.Drawing.PointF structure that specifies the image offset. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A List of vector image elements. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The action. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Creates a new SvgBitmap object from the specified vector image. + + A path to the image file. + The SvgBitmap object. + + + + Creates a new SvgBitmap object from the specified stream that stores a vector image. + + The stream that stores the image. + The SvgBitmap object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The PointF structure that specifies the coordinates of the test-point. + + + + Returns a raster image with the specified scale factor based on the SVG bitmap. + + A color palette of the current application skin and visual element state. + The scale factor. 1 to draw an image as is. + DefaultBoolean.True to enable high-speed rendering; otherwise, DefaultBoolean.False. + DefaultBoolean.True to enable image cache; otherwise, DefaultBoolean.False. + A raster image based on the SVG bitmap. + + + + Returns a raster image with the specified size based on the SVG bitmap. + + The image size, in pixels. + A color palette of the current application skin and visual element state. + DefaultBoolean.True to enable high-speed rendering; otherwise, DefaultBoolean.False. + DefaultBoolean.True to enable image cache; otherwise, DefaultBoolean.False. + A raster image based on the SVG bitmap. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + true to dispose the image; otherwise, false. + + + + Saves the image to the specified file. + + A path to the file to store the image. + + + + Gets or sets the scale factor. + + The scale factor. 1 to draw an image as is. + + + + A vector image. + + The SvgImage object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The SVG image rendering mode. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + An element (primitive) from which the vector image consists. + An element wrapper. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.dll b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.dll new file mode 100644 index 0000000..f9b4a8f Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.xml b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.xml new file mode 100644 index 0000000..1af6410 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Core.xml @@ -0,0 +1,13264 @@ + + + + DevExpress.Pdf.v23.2.Core + + + + + Contains classes used to create signatures for PDF and Office documents. + + + + + Provides certificates used to build a certificate chain and register the signature in the Document Security Store (DSS). + + + + + Initializes a new instance of the class with specified settings. + + A collection of X.509 certificates. + + + + Initializes a new instance of the class with specified settings. + + An X.509 store that contains the certificates. + true to transfer the store ownership to the CertificateStoreProvider instance; otherwise, false. + + + + Closes the underlying store. + + + + + Gets the certificate by its subject’s distinguished name. + + The BER-encoded DistinguishedName ASN.1 object (rfc5280) that represents the subject’s distinguished name. + The DER- or BER-encoded Certificate ASN.1 object (rfc5280) + + + + Allows you to send a CLR request for a certificate. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + A list of OCSP server Uri’s. + true to throw a WebException when the response failed; otherwise, false. + + + + Initializes a new instance of the class with specified settings. + + A list of OCSP server Uri’s. + + + + Returns a list of CertificateList ASN.1 objects. + + A list of DER-encoded x509 certificates to check. + A collection of DER- or BER-encoded CertificateList ASN.1 objects. + + + + Allows you to calculate a digest from a stream. Supports hash algorithms listed in enumeration. + + + + + Initializes a new instance of the class with specified settings. + + The hashing algorithm. + + + + Retrieves the hash algorithm’s object identifier. + + An algorithm OID. + + + + Calculates the digest value for specified data. + + The stream that contains data used to calculate the digest value. + The digest value. + + + + Returns the digest value’s size. + + The digest value’s size (in bytes). + + + + Lists values used to specify the signature’s secure hash algorithm (SHA) type. + + + + + SHA1 hashing algorithm. This type can affect the signature’s integrity, authenticity, and legal validity. + + + + + SHA256 hashing algorithm. + + + + + SHA384 hashing algorithm. + + + + + SHA512 hashing algorithm. + + + + + Provides certificates used to build a certificate chain and register the signature in the Document Security Store (DSS). + + + + + Gets the certificate by its subject’s distinguished name. + + The BER-encoded DistinguishedName ASN.1 object (rfc5280) that represents the subject’s distinguished name. + The DER- or BER-encoded Certificate ASN.1 object (rfc5280). + + + + Allows you to send a CLR request for specific a certificate. + + + + + Returns a list of CertificateList ASN.1 objects. + + A list of DER-encoded x509 certificates to check. + A collection of DER- or BER-encoded CertificateList ASN.1 objects. + + + + Allows you to calculate a digest from a stream. + + + + + Retrieves the hash algorithm’s object identifier. + + An algorithm OID. + + + + Calculates the digest value for the specified data. + + The stream that contains data used to calculate the digest value. + The digest value. + + + + Returns the digest value’s size. + + The digest value’s size (in bytes). + + + + Allows you to send an Online Certificate Status Protocol (OCSP) request for a certificate. + + + + + Returns a DER- or BER-encoded OCSPResponse ASN.1 object. + + A DER-encoded x509 certificate to check. + A DER-encoded x509 issuers certificate. + A DER- or BER-encoded OCSPResponse ASN.1 object or null. + + + + Allows you to send an Online Certificate Status Protocol (OCSP) request for a certificate. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An OCSP server URI. If not specified, the certificate data is used. + The hashing algorithm used to hash the issuer name and issuer public key. Default value is HashAlgorithmType.SHA1. + + + + Initializes a new instance of the class with specified settings. + + An OCSP server URI. If not specified, the certificate data is used. + + + + Returns a DER- or BER-encoded OCSPResponse ASN.1 object. + + A DER-encoded x509 certificate to check. + A DER-encoded x509 issuers certificate. + DER- or BER-encoded OCSPResponse ASN.1 object or null. + + + + Fires when the OCSP response fails. + + + + + Initializes a new instance of the class with specified settings. + + An exception message. + + + + Contains classes used to add signature timestamps. + + + + + Interface used to generate time stamps. + + + + + Generates a timestamp and returns its contents. + + The document’s hash value. + The hash algorithm’s object identifier. + The timestamp contents. + + + + Generates a timestamp for the specific data. + + A stream that contains data used to generate a timestamp. + An ASN.1 BER-encoded TimeStampToken (see rfc3161) object. + + + + Allows you to generate timestamps. + + + + + Initializes a new instance of the class with specified settings. + + A URI of a timestamp server. + A timestamp’s hashing algorithm. + A username to log into the server. + A password to log into the server. + + + + Initializes a new instance of the class with specified settings. + + A URI of a timestamp server. + A timestamp’s hashing algorithm. + + + + Initializes a new instance of the class with specified settings. + + A URI of a timestamp server. + An objects used to calculate the digest value. + A username to log in to the server. + A password to log in to the server. + + + + Initializes a new instance of the class with specified settings. + + A URI of a timestamp server. + An objects used to calculate the digest value. + + + + Generates a timestamp and returns its contents. + + The document’s hash value. + The hash algorithm’s object identifier. + The timestamp contents. + + + + Generates a timestamp for the specific data. + + A stream that contains data used to generate a timestamp. + An ASN.1 BER-encoded TimeStampToken (see rfc3161) object. + + + + Fires when timestamp request was rejected by the server. + + + + + Initializes a new instance of the class with specified settings. + + An error code with a description. + + + + Contains classes and enumerations that are used to implement the main functionality of WinForms and WPF PDF Viewers, and the PDF Document API. + + + + + Contains information about the signature contents. + + + + + Initializes a new instance of the class with specified settings. + + The signature type. + The signature size (in bytes). + The signature’s hashing algorithm. + + + + Initializes a new instance of the class with specified settings. + + The signature type. + The signature size (in bytes). + The signature’s digest calculator. + + + + Initializes a new instance of the class with specified settings. + + The signature type. + The name of the preferred signature handler. + The signature’s encoding and key information. + The signature size (in bytes). + The signature’s hashing algorithm. + + + + Initializes a new instance of the class with specified settings. + + The signature type. + The name of the preferred signature handler. + The signature’s encoding and key information. + The signature size. + The signature’s digest calculator. + + + + Returns the signature’s digest calculator. + + An object used to calculate the digest value. + + + + Retrieves the name of the preferred signature handler. + + Preferred signature handler’s name. + + + + Returns the signature size (in bytes). + + The signature size (in bytes). + + + + Returns information about the signature’s format. + + The signature’s encoding and key information. + + + + Returns the signature type. + + The signature type. + + + + Exposes the basic functionality to generate signatures. + + + + + Builds the signature and returns its contents. + + The document’s hash value. + The hash algorithm’s object identifier. + The signature contents. + + + + Builds the signature for the specified document. + + A stream that contains the document to sign. + A signature. + + + + Retrieves the name of the preferred signature handler. + + Preferred signature handler’s name. + + + + Returns the signature size (in bytes). + + A signature’s size (in bytes). + + + + Returns information about the signature’s format. + + The signature’s encoding and key information. + + + + Returns the signature type. + + The signature type. + + + + For internal use. Provides the functionality of and classes. + + + + + For internal use. + + A object. + + + + Contains classes and an enumeration that provides the localization functionality common to WinForms and WPF PDF Viewers, and the PDF Document API. + + + + + Provides the means to localize the dialog messages of a PDF Viewer. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies a localizer object providing localization of a PDF Viewer‘s dialog messages at runtime. + + An descendant, used to localize the dialog messages at runtime. + + + + For internal use. Returns a Localizer object storing resources based on the thread’s language and regional settings (culture). + + An object, storing resources based on the thread’s language and regional settings (culture). + + + + Returns a localized string for the given string identifier. + + A enumeration value, identifying the string to localize. + A value, corresponding to the specified identifier. + + + + Returns the name of the language currently used by this localizer object. + + A value that specifies the language of the user interface localization. + + + + A default localizer to translate the PDF Viewer’s resources. + + + + + Initializes a new instance of the class with the default settings. + + + + + Contains strings that correspond to the dialog messages of the PDF Viewer that are subject to localization. + + + + + “Insert Text” + + + + + “Oval” + + + + + “Custom” + + + + + “File Attachment” + + + + + “Text Box” + + + + + “Highlight” + + + + + “Pencil” + + + + + “Line” + + + + + “Polygon” + + + + + “Polygonal Line” + + + + + “Redact” + + + + + “Stamp” + + + + + “Sound Attachment” + + + + + “Rectangle” + + + + + “Squiggly Underline” + + + + + “Strikethrough” + + + + + “Sticky Note” + + + + + “Underline” + + + + + “Document“ + + + + + “{0:0.00} {1} ({2} Bytes)“ + + + + + “{0} Bytes“ + + + + + “The form field name cannot be null or an empty string.” + + + + + “The siblings can’t have the same names in the form field hierarchy.” + + + + + “\r\nDescription: {0}” + + + + + “Name: {0}” + + + + + “\r\nModification Date: {0}” + + + + + “\r\nSize: {0}” + + + + + “The selected index cannot be set because there are no possible values.” + + + + + Custom property name cannot be null or empty string. + + + + + “Unable to find an entry point named "{0}" in shared library "{1}"“ + + + + + “The document structure does not contain a field with the specified name: {0}.“ + + + + + “Unable to load ICU library.” + + + + + “The operation is not supported in {0} compatability mode. Please create document in PdfCompatibility.Pdf compatibility mode.” + + + + + “The export value cannot be null or an empty string.” + + + + + “The form field name cannot contain a period character.” + + + + + “The specified action does not belong to the current document.” + + + + + “Bookmark list can’t be null.” + + + + + “The argument should be the name of a button appearance or a value from the options array.“ + + + + + “The argument should be a string value or a list of string values from the options array.“ + + + + + “The color component value should be greater than or equal to 0 and less than or equal to 1.“ + + + + + “The dash length should be greater than or equal to 0.“ + + + + + “The sum of dash and gap lengths should be greater than 0.“ + + + + + “The dash pattern array must not be empty.“ + + + + + “The specified destination does not belong to the current document.” + + + + + “The destination of a bookmark can’t be linked to a page which belongs to another document.” + + + + + “Resolution (in dots per inch) should be greater than 0.” + + + + + “The flatness tolerance should be greater than or equal to 0 and less than or equal to 100.“ + + + + + “Error while reading the PDF Form from the specified file.“ + + + + + “The gap length should be greater than or equal to 0.“ + + + + + “The glyph position should be less or equal than text length.“ + + + + + “The page number should be greater than 0, and less than or equal to the next available page number (next to the document page count)”. + + + + + “The largest edge length should be greater than 0.“ + + + + + “The line width should be greater than or equal to 0.“ + + + + + “The list should contain at least one value.“ + + + + + “The marked content tag can’t be empty.“ + + + + + “The specified annotation does not belong to the current document.” + + + + + “The miter limit should be greater than 0.“ + + + + + “The opacity value should be greater than or equal to 0 and less than or equal to 1.” + + + + + “The page art box should be less than or equal to the media box.“ + + + + + “The page bleeding box should be less than or equal to the media box.“ + + + + + “The page croppoing box should be less than or equal to the media box.“ + + + + + “The page number should be greater than 0.“ + + + + + “The page rotation angle can have one of the following values: 0, 90, 180 or 270 degrees.“ + + + + + “The page trimming box should be less than or equal to the media box.“ + + + + + “Input data are not recognized as valid pdf.“ + + + + + “The Document Open password is empty or incorrect.“ + + + + + “Unable to create a print document with the specified name: {0}.“ + + + + + “The top coordinate of the rectangle should be greater than the bottom.“ + + + + + “The right coordinate of the rectangle should be greater than the left one.“ + + + + + “The index should be in the range from 0 to {0}.” + + + + + “The text value can’t be null.“ + + + + + “The argument should be a string value.“ + + + + + “The text horizontal scaling value should be greater than 0.“ + + + + + “The zoom value should be greater than or equal to 0“. + + + + + “At least one page number should be specified.” + + + + + “The page number should be greater than or equal to 1.” + + + + + “This operation cannot be performed in the Partial Trust environment.” + + + + + “Unable to load shared library "{0}" or one of its dependencies: "{1}"“ + + + + + “All fonts should be embedded to a PDF/A document.” + + + + + “The stream is already used for a document. Please use another stream.” + + + + + “This operation is not available while no document is being loaded.“ + + + + + Cannot resolve the prefix specified in the qualifiedName. Make sure you registered the prefix and the corresponding namespace in the XmpDocument.RegisterNamespace method call. + + + + + “The text highlight annotation is not supported in a PDF/A-1 document.” + + + + + “Custom brushes are not supported.” + + + + + “Encryption is not supported in a PDF/A document.“ + + + + + “The file attachments are not supported in a PDF/A-2b document.” + + + + + “This operation is not supported because the PdfGraphics object does not belong to the current document.” + + + + + “The Display and World units are not supported for the source image coordinate system.” + + + + + “Stream should support the read, write, and seek operations.” + + + + + “Stream should support the read and seek operations for loading.” + + + + + “Stream should support the write and seek operations for saving.” + + + + + “This action can be performed only on Windows operating system.” + + + + + “The color should have at least one component.“ + + + + + “Approved” + + + + + “As Is” + + + + + “Confidential” + + + + + “Approved” + + + + + “{0} {1}” + + + + + “g” + + + + + “Confidential” + + + + + “{0}” + + + + + “Departmental” + + + + + “Draft” + + + + + “Received” + + + + + “{0} {1}” + + + + + “Reviewed” + + + + + “{0} {1}” + + + + + “Revised” + + + + + “{0} {1}” + + + + + “Experimental” + + + + + “Expired” + + + + + “Final” + + + + + “Comment” + + + + + “For Public Release” + + + + + “Not Approved” + + + + + “Not For Public Release” + + + + + “Accepted” + + + + + “Initial Here” + + + + + “Rejected” + + + + + “Sign Here” + + + + + “Witness” + + + + + “Sold” + + + + + “Top Secret” + + + + + “Digitally signed by {0}” + + + + + “Date: {0}” + + + + + “DN: {0}” + + + + + “Location: {0}” + + + + + “Reason: {0}” + + + + + “Note” + + + + + “Highlight” + + + + + “Strikethrough” + + + + + “Underline” + + + + + “EB“ + + + + + “GB“ + + + + + “KB“ + + + + + “MB“ + + + + + “PB“ + + + + + “TB“ + + + + + “ZB“ + + + + + Provides appearance settings used to paint the border of an interactive form field. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the color of an interactive form field border. + + A object that specifies the border color. + + + + Specifies the style of an interactive form field border. + + One of the enumeration values that represents the style of an interactive form field border. + + + + Specifies the width of the interactive form field border. + + A value that is the width of the interactive form field border. The default value is 1. + + + + Specifies the border style for an interactive form field. + + + + + Beveled border. + + + + + Dashed border. + + + + + Inset border. + + + + + Solid border. + + + + + Lists values used to specify the appearance of the form field’s marker. + + + + + Check button style. + + + + + Circle button style. + + + + + Cross button style. + + + + + Diamond button style. + + + + + Square button style. + + + + + Star button style. + + + + + Represents a check box field. + + + + + Initializes a new instance of the class with the specified check box field name, page number, where the field will be created, and the field rectangle. + + A that specifies the name of check box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which check box field is located on a page. + + + + Adds a widget annotation related to the check box. The widget is added to the page where the form field is located. + + The page rectangle where the widget annotation should be added. + + + + Adds a widget annotation related to the check box. Allows you to specify a page to which the widget should be added. + + The number of a page to which to add the widget annotation (starting with 1). + The page rectangle where to add the widget annotation. + + + + Specifies a button style which is applied to a check box field. + + A enumeration value that determines the button style applied to a check box field. + + + + Removes all additional widget annotations. + + + + + Specifies an export value of a check box field. + + A value which represents an export value of a check box field. + + + + Gets or sets whether a check box is checked. + + true, if the check box is checked; otherwise, false. Default value is false. + + + + Specifies whether to generate a down appearance that will appear in a check box when the mouse button is pressed within the check box area. + + true, if a down appearance is generated within the check box area; otherwise, false. Default value is true. + + + + Represents the base class for combo box and list box fields. + + + + + Adds an item to a combo box and list box using their display and export values. + + A that is a value to be added to a combo box and list box. + A that is an export value. + + + + Adds an item to a combo box and list box by their display value. + + A that is a value to be added to a combo box and list box. + + + + Adds a widget annotation related to the choice form field (combo box or list box). The widget is added to the page where the form field is located. + + The page rectangle where the widget annotation should be added. + + + + Adds a widget annotation related to the choice form field (combo box or list box). Allows you to specify a page to which the widget should be added. + + The number of a page to which to add the widget annotation (starting with 1). + The page rectangle where the widget annotation should be added. + + + + Clears the combo box or list box selection. + + + + + Removes all values to be added to the list box and combo box. + + + + + Removes all additional widget annotations. + + + + + Selects an item of a combo box and list box by their export value. + + A value that represents the item’s export value. + true, if the combo box or list box item was successfully selected; otherwise, false. + + + + Sets the specified item’s selection state in combo box and list box fields. + + The zero-based index of the item whose selection state will be changed. + true, to select the item; false, to unselect the item. + + + + Represents a combo box field. + + + + + Initializes a new instance of the class with the specified combo box field name, page number, where the field will be created, and the field rectangle. + + A that specifies the name of combo box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a combo box field is located on a page. + + + + Gets or sets a value that determines whether text within a text box of the combo box field can be edited. + + true, if text within a text box of the combo box field can be edited; otherwise, false. The default value is false. + + + + Provides access to the field value format options. + + An object that allows you to specify the value format. + + + + Represents the base class for common field types such as text box, check box, list box, combo box, and signature. + + + + + Specifies a rectangle inside which an interactive form field is located on a page. + + A object that represents a field rectangle. + + + + Specifies the horizontal alignment of the interactive form field’s text. + + A enumeration value that specifies how the text is horizontally aligned within the interactive form field. + + + + Lists values used to specify currency style. + + + + + The currency symbol is placed after the number. + + + + + The currency symbol with space is placed after the number. + + + + + The currency symbol is placed before the number. + + + + + The currency symbol with space is placed before the number. + + + + + No currency sign. + + + + + Exposes a set of methods used to organize AcroForm fields without access to their inner structure. + + + + + Gets a specific button form field’s properties. + + A form field name. + An object that contains the button form field properties. + + + + Gets a specific check box form field’s properties. + + A form field’s name. + An object that contains the form field’s properties. + + + + Gets a specific combo box form field’s properties. + + A form field’s name. + An object that contains the form field’s properties. + + + + Gets all AcroForm fields’ properties. + + A list of objects that contain form field properties. + + + + Gets a specific form field’s properties. + + A form field’s name. + An object that contains the form field’s properties. + + + + Gets a specific list box form field’s properties. + + A form field’s name. + An object that contains the form field’s properties. + + + + Retrieves a list of form field names. + + A list of form field names. + + + + Gets a specific radio group form field’s properties. + + A form field’s name. + An object that contains the form field’s properties. + + + + Gets a specific signature form field’s properties. + + The form field name. + An object that contains the form field’s properties. + + + + Gets a specific text form field’s properties. + + The form field name. + An object that contains the form field properties. + + + + Represents the base class for all interactive form fields. + + + + + Creates a check box field using the field name, page number, and a rectangle where the check box field will be located on a page. + + A that specifies the name of a check box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a check box field is located on a page. + A object that represents a created check box field. + + + + Creates a combo box field using the field name, page number, and a rectangle where the combo box field will be located on a page. + + A that specifies the name of a combo box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a combo box field is located on a page. + A object that represents a created combo box field. + + + + Creates a group form field using the field name. + + A that specifies the name of a group field. + A object that represents a created group form field. + + + + Creates a list box field using the field name, page number and a rectangle where the list box field will be located on a page. + + A that specifies the name of a list box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a list box field is located on a page. + A object that represents a created list box field. + + + + Creates a radio group field using the field name, and page number. + + A that specifies the name of a radio group field. + An integer value that specifies the page number where the form field will be created. + A object that represents a created radio group field. + + + + Creates a signature field using the field name, page number and a rectangle where a signature field will be located on a page. + + A that specifies the name of a signature field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a signature field is located on a page. + A object that represents a created signature field. + + + + Creates a text box field using the field name, page number, and a rectangle where a text box field will be located on a page. + + A that specifies the name of a text box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a text box field is located on a page. + A object that represents a created text box field. + + + + Specifies the interactive form field name. + + A value that is the field name. + + + + Specifies the form field’s tooltip text. + + A value that specifies the text displayed within the form field’s tooltip. + + + + Provides appearance settings used to paint an interactive form field. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the form field’s background color. + + A object that represents the form field’s background. The default value is null that corresponds to a transparent background color. + + + + Specifies the border appearance settings for an interactive form field. + + A object that specifies the border appearance for the interactive form field. The default value is null (a border is not displayed in a form field). + + + + Specifies the font family name for an interactive form field. + + A that specifies the font family name. + + + + Specifies the size of the interactive form field’s font. + + A value representing the font size for the interactive form field. The default value: 12. + + + + Specifies the style of the form field font. + + A value, representing the font style. The default value is PdfFontStyle.Regular. + + + + Specifies the foreground color of an interactive form field. + + A object that specifies the interactive form field’s foreground color. + + + + Represents a structure which stores information about a collision found in interactive form field names. + + + + + Gets the form field in which a collision with a name was detected. + + A object that represents the interactive form field. + + + + Provides access to the collection of forbidden field names that was generated as a result of a collision found in the field names. + + A object implementing the System.Collections.Generic.ISet interface that represent the forbidden names. + + + + Specifies a form field’s rotation degree. + + + + + The form field is not rotated. This is the default value. + + + + + Rotate the form field by 180 degrees. + + + + + Rotate the form field by 270 degrees. + + + + + Rotate the form field by 90 degrees. + + + + + Represents a group field. + + + + + Initializes a new instance of the class with the specified group field name. + + A that specifies the name of the group field. + + + + Returns the collection of group form field children. + + A list of objects that are the collection of form field child nodes. + + + + Represents a list box field. + + + + + Initializes a new instance of the class with the specified list box field name, page number, where the field will be created, and the field rectangle. + + A that specifies the name of list box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a list box field is located on a page. + + + + Specifies whether multiple items can be selected simultaneously in the list box field. + + true, if multiple selections of list box items are allowed; otherwise, false. + + + + Specifies the index of the first visible item in the list box field. + + An integer value that is the zero-based index of the first visible item in the list box. Default value is 0. + + + + Lists values used to specify negative number format. + + + + + No negative number format. + + + + + Displays a negative number in brackets. + + + + + Displays a negative number in red. + + + + + Lists values used to specify the separator format. + + + + + Apostrophe separates thousands, dot separates decimals. + + + + + Comma is a decimals separator. + + + + + Comma is a thousands separator, dot is a decimals separator. + + + + + Dot is a decimals separator. + + + + + Dot is a thousands separator, comma is a decimals separator. + + + + + Represents a radio group field. + + + + + Initializes a new instance of the class with the specified radio group field name and page number where the field will be created. + + A that specifies the name of radio group field. + An integer value that specifies the page number where the form field will be created. + + + + Adds a radio button to the radio group field. The button is added to the page where the form field is located. + + The name of a radio button. + A page area where the radio button should be located. + + + + Adds a radio button to the radio group field. Allows you to specify a page where the button should be located. + + The name of a radio button. + The number of the page where the radio button should be located. + A page area where the radio button should be located. + + + + Specifies the style that defines the appearance of a radio button within a radio group field. + + A enumeration value that determines the style of a radio button within a radio group field. + + + + Removes all radio buttons from the radio group field. + + + + + Gets the number of radio buttons in the radio group field. + + An integer value that is the number of radio buttons in the radio group field. + + + + Specifies index of the selected item in a radio group field. + + An integer value, representing the zero-based index of the radio group’s selected item. + + + + Specifies whether to generate a down appearance that will appear when the mouse button is pressed within a radio button area. + + true, if a down appearance is generated within the radio button area; otherwise, false. Default value is true. + + + + Represents a signature field. + + + + + Initializes a new instance of the class with the specified signature field name, page number, where the field will be created, and the field rectangle. + + A that specifies the name of the signature field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle inside which a signature field is located on a page. + + + + Specifies the vertical alignment of the string within the signature field. + + A enumeration value that represents vertical line alignment. + + + + Specifies text displayed in a signature field. + + A value which represents the text displayed in the signature field. + + + + Lists values used to specify special value format types. + + + + + A five-digit postal code. + + + + + A nine-digit postal code. + + + + + A ten-digit telephone number. + + + + + A nine-digit US social security number. + + + + + Specifies text alignment in an interactive form field. + + + + + Text is aligned in the center of a field rectangle. + + + + + Text is aligned far from the origin position of a field rectangle. + + + + + Text is aligned near to the origin position of a field rectangle. + + + + + Represents a text box field. + + + + + Initializes a new instance of the class with the specified text box field name, page number, where the field will be created, and the field rectangle in user coordinate system. + + A that specifies the name of text box field. + An integer value that specifies the page number where the form field will be created. + A object that represents a rectangle in user coordinate system used to place a text box field. + + + + Adds a widget annotation related to the text box. The widget is added to the page where the form field is located. + + The page rectangle where to add the widget annotation. + + + + Adds a widget annotation related to the text box. Allows you to specify a page to which the widget should be added. + + The number of a page to which to add the widget annotation (starting with 1). + The page rectangle where to add the widget annotation. + + + + Removes all additional widget annotations. + + + + + Specifies the maximum text length for a text box field. + + A positive integer value specifying the maximum number of characters allowed in a text box field or 0 indicating that the number of characters in a text box field is not limited.The default value is 0. + + + + Specifies whether the text box field should contain multiple lines of text. + + true, if the text box field can contain multiple lines of text; otherwise, false. + + + + Specifies whether a text box field can be scrollable when the entered text exceeds the field area. + + true, if a text box field is scrollable when the entered text exceeds the field area; otherwise, false. + + + + Specifies whether text entered to a text box field is spell checked. + + true, if text entered to a text box field is spell checked; otherwise, false. + + + + Specifies text of the text box field. + + A value which represents the text displayed in the text box field. + + + + Specifies the type of the text box field. + + A enumeration value that represents the text box field type. + + + + Provides access to the field value format options. + + An object that allows you to specify the value format. + + + + Lists values used to specify a text form field’s input format. + + + + + The field value is a path to a file. + + + + + The field value is a password. + + + + + The field value is a plain text string. + + + + + Allows you to specify format for form field values. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the JavaScript to be performed when the field’s value is changed. This action may check the new value for validity. + + The calculation JavaScript. For JS API reference, use JavaScript for Acrobat API Reference + + + + Create a date and time format for a form field value. + + Specifies the date and time format. + An object that contains the date and time format. + + + + Creates a number format for a form field value. + + A number of decimal places. + An enumeration value that indicates the number separator style. + A currency symbol. + An enumeration value that indicates the currency style. + An enumeration value that indicates the negative number style. + An object that contains the number format. + + + + Creates a number format for a form field value. + + A number of decimal places. + An enumeration value that indicates the number separator style. + An object that contains the number format. + + + + Creates a percent format for a form field value. + + A number of decimal places. + An enumeration value that indicates the separator style. + An object that contains the percent format. + + + + Creates a special format for the form field values. + + An enumeration value that indicates the special format style. + An object that contains the special format. + + + + Creates a special format for the form field values. + + Specifies what characters can be inserted and how they are displayed. + An object that contains the special format. + + + + Creates a time format for a form field value. + + Specifies the time format. + An object that contains time format. + + + + Gets or sets the JavaScript to be performed before the field is formatted. This action may modify the field’s value before formatting. + + The format JavaScript. For JS API reference, use JavaScript for Acrobat API Reference + + + + Gets or sets the JavaScript to be performed when the user modifies a character in a This action may check the added text for validity and reject or modify it. + + The keystroke JavaScript. For JS API reference, use JavaScript for Acrobat API Reference + + + + Gets os sets the JavaScript to be performed to recalculate the value of this field when that of another field changes. + + The validation JavaScript. For JS API reference, use JavaScript for Acrobat API Reference + + + + Represents the base class for visual form fields. + + + + + Specifies the appearance settings for the interactive form field. + + A object that specifies the appearance for the interactive form field. + + + + Specifies page number where the interactive form field will be created. + + An integer value specifying the number of a page. + + + + Specifies whether the current form field is printed. + + true, if the current form field is printed on the page, otherwise, false. The default value is true. + + + + Gets or sets whether the interactive form field allows edit operations. + + true, if end-users cannot modify the form field’s value; otherwise, false. + + + + Gets or sets the required status of the interactive form field. + + true, if the form field must have a value at the time it is exported by a submit-form action; otherwise, false. + + + + Specifies the rotation to apply to interactive form field. + + A enumeration value that represents the degree by which a form field is rotated counterclockwise relative to the page. + + + + Specifies whether the form field is visible on the page. + + true, if the form field is visible; otherwise, false. The default value is true. + + + + An action that is performed with interactive elements (e.g., bookmarks, annotations) in the PDF document. + + + + + Gets the next action that is performed after the action from the list of objects. + + A list of objects that is the sequence of actions that should be performed. + + + + Represents an annotation that is used for adding text notes and other ancillary information to the document. + + + + + Gets the annotation’s appearance state on the PDF form. + + A object that represents the current annotation’s appearance state on the PDF form. + + + + Gets or sets the name of the appearance which is currently being used to draw the annotation on the PDF form. + + A value that is the appearance name. + + + + Gets the annotation’s border, which will be drawn as a rounded rectangle. + + A object that represents the annotation’s border. + + + + Gets the color of the annotation. + + A object that is the annotation color. + + + + Gets the text that will be displayed for the annotation on the PDF form. + + A value that is the text that will be displayed for the annotation. + + + + Gets or sets flags that specify various characteristics of the annotation. + + A set of annotation flags. + + + + Gets the date and time when the annotation was most recently modified. + + A structure. + + + + Gets the annotation name. + + A value that defines the string that identifies the annotation on the page. + + + + Gets the optional content specifying the optional content properties for the annotation. + + A object that is the optional content for the annotation. + + + + Gets the page with which the annotation is associated. + + A object that is the individual page in the document. + + + + Gets the annotation rectangle that defines the location of the annotation on the page in default user space units. + + A object that represents the annotation rectangle on the page. + + + + Gets the integer key of the annotation’s entry in the structural parent tree. + + A nullable integer value specifying the key of the annotation’s entry. + + + + Represents actions that can be performed with the annotation in the document. + + + + + Gets an action that is performed when the cursor enters the annotation’s active area. + + A object that represents the action. + + + + Gets an action that is performed when the cursor exits the annotation’s active area. + + A object that represents the action. + + + + Gets an action that is performed when the annotation loses the input focus. + + A object that represents the action. + + + + Gets an action that is performed when the annotation receives the input focus. + + A object that represents the action. + + + + Gets an action that is performed when the mouse button is pressed inside the annotation’s active area. + + A object that represents the action. + + + + Gets an action that is performed when the mouse button is released inside the annotation’s active area. + + A object that represents the action. + + + + Gets an action that is performed when the page containing the annotation is no longer visible in the reader’s user interface. + + A object that represents the action. + + + + Gets an action that is performed when the page containing the annotation becomes visible. + + A object that represents the action. + + + + Gets an action that is performed when the page containing the annotation is closed. + + A object that represents the action. + + + + Gets an action that is performed when the page containing the annotation is opened. + + A object that represent the action. + + + + Determines a form with the annotation appearance. + + + + + Gets a default form in which an annotation appearance is represented. + + A object that is a default form. + + + + Gets custom forms with annotation appearances. + + A dictionary, containing the objects, along with their key values. + + + + Represents annotation appearances on the PDF form. + + + + + Gets the annotation’s down appearance. + + A object that is the down appearance. + + + + Gets a form on the page with an annotation appearance. + + A object that is the form on the page. + + + + Gets the annotation’s normal appearance. + + A object that is the normal appearance. + + + + Gets the annotation’s rollover appearance. + + A object that is the rollover appearance. + + + + Represents the annotation’s border settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the horizontal corner radius of the annotation’s border, which will be drawn as a rounded rectangle. + + A double value that is the horizontal corner radius of the annotation’s border. + + + + Gets a value that defines whether the default appearance of the annotation border is drawn on the page. + + true, if the annotation border is drawn with the default appearance; otherwise, false. + + + + Gets the line style of the annotation border. + + A enumeration member that is the annotation border line style. + + + + Gets the thickness of the line to be used in drawing the annotation’s border. + + A double value that is the line width of the annotation’s border. + + + + Gets the vertical corner radius of the annotation’s border, which will be drawn as a rounded rectangle. + + A double value that is the vertical corner radius of the annotation’s border. + + + + Lists values that specify the effect applied to the annotation border. + + + + + The border appears “cloudy”– the border is drawn as a series of convex curved line segments. + + + + + No effect is applied. + + + + + Contains style settings of the annotation’s border. + + + + + Gets the name of the beveled style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the name of the dashed style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the name of the inset style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the line style settings of the annotation’s border. + + A object that represents the line style settings of the annotation’s border. + + + + Gets the name of the solid style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the name of the style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the name of the underline style to be applied to the annotation’s border. + + A that is the name of the annotation’s border style. + + + + Gets the annotation’s border width in points. + + A double value that is the width of the annotation’s border. Default value: 1. + + + + Base class for document annotations. + + + + + Gets the annotation type. + + The annotation type. + + + + Gets the annotation’s bounds on the page. + + The annotation’s bounds. + + + + Specifies the annotation color. + + The annotation color. + + + + Specifies the annotation comment. + + The annotation contents. + + + + Specifies the date and time when the annotation was last modified. + + The annotation’s modification date. + + + + Specifies the annotation’s name. + + The annotation name. + + + + Exposes members used to organize annotations without access to their inner structure. + + + + + Specifies the annotation color. + + The annotation color. + + + + Specifies the annotation comment. + + The annotation contents. + + + + Gets or sets flags that specify various characteristics of the annotation. + + A set of annotation flags + + + + Flattens the annotation. + + + + + Specifies the date and time when the annotation was last modified. + + The annotation’s modification date. + + + + Gets the annotation name. + + The annotation name. + + + + Rebuilds the annotation’s appearance. + + + + + Gets the annotation’s bounds on the page. + + A rectangle that defines the annotation’s location. + + + + Removes the annotation. + + + + + Returns the annotation type. + + The annotation type. + + + + Lists the values specifying various characteristics of the annotation, signature form field, or widget annotation. + + + + + Do not display or print the annotation or allow a user to interact with the annotation. + + + + + Do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. + + + + + Do not allow the annotation to be deleted or its properties to be modified by the user. + + + + + Do not allow the contents of the annotation to be modified by the user. + + + + + If active, deactivates all other options. + + + + + Do not rotate the annotation’s appearance to match the rotation of the page. + + + + + Do not display the annotation on the screen or allow a user to interact with the annotation. + + + + + Do not scale the annotation’s appearance to match the magnification of the page. + + + + + Print the annotation when the page is printed. + + + + + Do not let a user interact with the annotation. + + + + + Invert the interpretation of the NoView flag for certain events. + + + + + Lists values that specify the visual effect activated when the mouse button is pressed or held down inside the annotation’s active area. + + + + + Invert the contents of the annotation rectangle. + + + + + No highlight. + + + + + Invert the annotation’s border. + + + + + Display the annotation as if it was pushed below the surface of the page. + + + + + Display the annotation’s down appearance. + + + + + Lists values used to specify the style of the annotation’s end points. + + + + + A short perpendicular line. + + + + + A circle. + + + + + A closed arrow. + + + + + A diamond. + + + + + No symbol. + + + + + An open arrow. + + + + + A reversed closed arrow. + + + + + A reversed open arrow. + + + + + A short diagonal line. + + + + + A square. + + + + + Lists values used to specify the annotation’s review status. + + + + + The annotation is reviewed and accepted. + + + + + The annotation is reviewed and cancelled. + + + + + The annotation is reviewed and completed. + + + + + No review status. + + + + + The annotation is reviewed and rejected. + + + + + Lists values used to indicate the annotation type. + + + + + 3D annotation. + + + + + Insertion caret. + + + + + Circle annotation. + + + + + Custom annotation. + + + + + File attachment. + + + + + Free text annotation. + + + + + Ink annotation (a freehand “scribble” composed of one or more disjoint paths). + + + + + Line annotation. + + + + + Link annotation. + + + + + Video attachment. + + + + + Polygon annotation. + + + + + Polyline annotation. + + + + + Pop-up annotation. + + + + + Printer’s mark annotation (a symbol added to a page to maintain consistent output during production). + + + + + Redaction annotation. + + + + + Rich Media annotation (SWF files and and enhanced rich media attachments). + + + + + Stamp annotation. + + + + + Screen annotation (a page region on which to play media clips). + + + + + Audio attachment. + + + + + Rectangle annotation. + + + + + Text annotation. + + + + + Text markup annotation. + + + + + Trap network (a set of trapping instructions for the page) annotation. + + + + + Watermark annotation. + + + + + Widget annotation. + + + + + Lists the values used to specify the type of relationship between the document and the attached file. + + + + + The attached file specification has an alternative representation of the content (e.g., audio). + + + + + The attached file represents information used to derive a visual presentation (e.g. for a table or a graph). + + + + + The file specification is an encrypted payload document that should be displayed to the user if the PDF Document Processor has the cryptographic filter needed to decrypt the document. + + + + + The attached file has the original source material for the associated content. + + + + + The attached file represents a supplemental representation of the original source or data. + + + + + The relationship is unknown or does not match any relationship above. + + + + + Contains settings that are used to specify bookmarks in a document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the bookmark action being executed. + + A object that is an action that is performed with bookmarks. + + + + Gets or sets the collection of bookmark children for a document with a tree-structured hierarchy. + + A list of objects that are the collection of bookmark child nodes. + + + + Gets or sets a destination with which a bookmark is associated. + + A destination. + + + + Gets or sets the value indicating whether the bookmark text is bold. + + true, if the bookmark text is bold; otherwise, false. + + + + Gets or sets a value that indicates whether bookmarks are initially closed (bookmark children are hidden) in the navigation panel after a document is loaded. + + true, if the bookmark children are initially hidden (closed) in the navigation panel; otherwise, false. + + + + Gets or sets the value indicating whether the bookmark text is italic. + + true, if the bookmark text is italic; otherwise, false. + + + + Gets or sets the color for a bookmark’s text in the navigation pane. + + A object that is a single color in the RGB (red, green, blue) color scheme for a bookmark’s text. + + + + Gets or sets the bookmark’s text on the navigation pane. + + A that is the text for a bookmark on the navigation pane. + + + + Lists values used to specify the annotation’s and widget annotation’s border style. + + + + + A 3D outset border. Available for widget annotations only. + + + + + A line that consists of dashes. + + + + + A border that consists of a repeating dash-dot pattern. + + + + + A border that consists of a repeating short dash-dot-dot pattern. + + + + + A border that consists of dots. + + + + + A 3D inset border. Available for widget annotations only. + + + + + A solid border. + + + + + Only bottom border is displayed. + + + + + A button field (a push button, radio group, check box) on a PDF interactive form that the user can manipulate with the mouse. + + + + + Gets the default state of the button form field. + + A object that represents the default state of the button form field. + + + + Retrieves button field items. + + A list of items. + + + + Gets the kids state of the button form field. + + A collection of objects that represent the kids state of the button form field. + + + + Gets or sets whether to turn radio buttons on and off in unison. + + true to turn radio buttons on and off in unison; otherwise, false. + + + + Gets the state of the button form field. + + A object that represents the state of the button form field. + + + + Gets or sets whether only one radio button can be selected. + + true to select one radio button at all times; otherwise, false. + + + + Gets the form field type. + + An enumeration value that indicates the form filed type (push button, radio group or check box). + + + + Contains a set of properties used to manage button form fields without access to their inner structure. + + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Contains properties used to change the button field’s widget annotation without access to its inner structure. + + + + + Gets or sets the widget annotation’s alternate (down) caption (displayed when a user clicks the button, but before the button is released). + + The alternate caption. + + + + Gets or sets the widget annotation’s caption (displayed when the button is not clicked). + + The normal caption. + + + + Retrieves the button widget’s icon options. + + The object that contains button icon options. + + + + Gets the button’s rollover caption (displayed when the mouse pointer hovers over the button). + + The button’s rollover caption. + + + + Specifies the button icon displayed when the user clicks the button, but before the button is released. + + The byte array that contains image data. + + + + Specifies the button icon displayed when the user clicks the button, but before the button is released. + + A stream that contains the icon. + + + + Specifies the button icon displayed when the user clicks the button, but before the button is released. + + The path to an icon file. + + + + Specifies the button icon displayed when the button is not clicked. + + The byte array that contains icon data. + + + + Specifies the button icon displayed when the button is not clicked. + + A stream that contains an icon. + + + + Specifies the button icon displayed when the button is not clicked. + + The path to an icon file. + + + + Specifies the button icon displayed when the mouse pointer hovers over the button. + + The byte array that contains icon data. + + + + Specifies the button icon displayed when the mouse pointer hovers over the button. + + The stream that contains the icon. + + + + Specifies the button icon displayed when the mouse pointer hovers over the button. + + The path to an icon file. + + + + Specifies the text position of the button widget’s caption relative to its icon. + + An enumeration value that indicates the caption position relative to the icon. + + + + Contains properties that define how to display the button’s icon in the widget annotation. + + + + + Gets or sets whether to fit the button icon in the widget annotation bounds or in its borders. + + true to fit the button icon in the annotation bounds; false to fit the icon in the annotation borders. + + + + Specifies the space between the icon and the left boundary of the widget. + + A double value (between 0.0 and 1.0) that is the space between the icon and the widget’s left boundary. + + + + Gets or sets the conditions under which the icon is scaled inside the annotation rectangle. + + An enumeration value that indicates the icon scale conditions. + + + + Gets or sets the icon’s scale type. + + An enumeration value that indicates the scaling type. + + + + Gets or sets the space between the icon and the widget’s bottom boundary. + + A double value (between 0.0 and 1.0) that is the space between the icon and the bottom boundary. + + + + Contains members used to manage caret annotations without access to their inner structure. + + + + + Lists values used to specify permissions granted by a signature. + + + + + Allows users to fill in forms and sign the document. + + + + + Allows users to fill in forms, create, modify and delete annotations, and sign the document. + + + + + All changes are allowed. + + + + + No changes are allowed. + + + + + An individual character in a document. + + + + + Initializes a new instance of the class with the specified settings. + + A value. This value is assigned to the PdfCharacter.UnicodeData property. + A value. This value is assigned to the PdfCharacter.Font property. + A value. This value is assigned to the PdfCharacter.FontSize property. + A value. This value is assigned to the PdfCharacter.Rectangle property. + + + + Returns the character’s font settings. + + A value. + + + + Returns the character’s font size (in points). + + A value, specifying the font size, in points. + + + + Returns a rectangle that surrounds the character. + + A value. + + + + Returns a Unicode representation of the character. + + A value, specifying a character’s Unicode representation. + + + + Stores a CMap table that maps character codes to Unicode values. + + + + + Stores raw data of the CMap table. + + An array of values. + + + + Contains a set of properties used to manage check box form fields without access to their inner structure. + + + + + Gets or sets whether a check box is checked. + + true if the check box is checked; otherwise, false. Default value is false. + + + + Gets or sets whether to select one check box at all times. + + true to select only one checkbox and if the user selects the selected checkbox again, it has no effect; false, to deselect the checkbox if it is selected again. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Contains properties used to change the check box field’s widget annotation without access to its inner structure. + + + + + Specifies the shape of the marker that appears inside the check box when the user selects it. + + An enumeration value that indicates the check box marker shape. + + + + Represents a choice field (a combo box, list box) on a PDF form. + + + + + Gets or sets whether to commit a new value once the selection is made. + + true, to commit a new form field value after a selection is made; false to commit a new value only after a user exists the field. + + + + Gets default values of the choice form field. + + A collection of objects that represent default values of the choice form field. + + + + Specifies whether to include an editable text box in the combo box. + + true to include an editable text box; otherwise, false. + + + + Gets a list of form field items. + + A list of form field items. + + + + Gets or sets whether multiple form field items can be selected simultaneously. + + true to allow multiple item selection; otherwise, false. + + + + Gets the list of options in the choice field. + + A collection of the objects that represent the list of options in the choice field. + + + + Gets a collection of integers, sorted in ascending order, representing the zero-based indices in the option list of the currently selected option items. + + A collection of integers representing the zero-based indices in the option list of the currently selected option items. + + + + Gets items currently selected in the choice field. + + A collection of objects that represent currently selected items in the choice field. + + + + Gets or sets whether to sort form field items alphabetically. + + true to sort form field items; otherwise, false. + + + + Gets or sets whether to check spelling in the combo box form field. + + true to enable spell checking; otherwise, false. + + + + Gets the index of the first option visible in the option list. + + An integer value that represents the top index. Default value is 0. + + + + Retrieves the form field type. + + An enumeration value that indicates the form field type. + + + + Contains properties that apply to list box an combo box form fields. + + + + + + Gets or sets whether to commit a new value once the selection is made. + + true to commit a new form field value after selection; false to commit a new value only after a user exists the field. + + + + Gets form field items. + + A list of form field items. + + + + Gets or sets whether to sort form field items alphabetically. + + true to sort form field items; otherwise, false. + + + + Gets or sets how the text is aligned in the form field. + + Indicates the text justification type. + + + + Exposes members used to organize circle annotations without access to their inner structure. + + + + + Contains options that specify what content type to keep in the page area that is to be cleared. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to clear annotations. + + true to remove annotations; otherwise, false. + + + + Gets or sets whether to clear graphics. + + true to remove graphics; otherwise, false. + + + + Gets or sets whether to clear images. + + true to remove images; otherwise, false. + + + + Gets or sets whether to clear text. + + true to remove text; otherwise, false. + + + + A collection of page regions to clear. + + + + + Initializes a new instance of the class. + + + + + Adds a page region to the collection. + + A page region. + true to use page coordinate system; otherwise, false. + + + + Adds a page region to the collection. + + A page region. + + + + Adds a page region to the collection. + + A page region. + true to use page coordinate system; otherwise, false. + + + + Adds a page region to the collection. + + A page region. + + + + Adds a list of page regions to the collection. + + A list of page regions. + true to use page coordinate system; otherwise, false. + + + + Adds a list of page regions to the collection. + + A list of page regions. + + + + Adds a list of page regions to the collection. + + A list of page regions. + true to use page coordinate system; otherwise, false. + + + + Adds a list of page regions to the collection. + + A list of page regions. + + + + Represents a color used in the PDF document. + + + + + Initializes a new instance of the class with the specified settings. + + A object that is the color pattern. + An array of double values that represent the color components. + + + + Initializes a new instance of the class with the specified color components. + + An array of double values representing the components in the color space in which the color is defined. + + + + Provides access to an array of numbers in the range from 0.0 to 1.0, representing the components in the color space in which the color is defined. + + An array of double numbers in the range from 0.0 to 1.0, representing the components in the color space. + + + + Determines whether the specified object is equal to the current PdfColor object. + + A PdfColor object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether the specified object is equal to the current PdfColor object. + + An object to compare with the current PdfColor object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns a number that identifies the object instance. + + An integer that identifies the color instance. + + + + Gets the color pattern. + + A object. + + + + Represents a PDF color space. + + + + + Gets the number of color components in the color space. + + An integer value that is the components count. + + + + Contains a set of properties used to manage combo box form fields without access to their inner structure. + + + + + Specifies whether to include an editable text box in the combo box. + + true to include an editable text box; otherwise, false to include only a drop-down list. + + + + Gets or sets whether to check spelling in the combo box form field. + + true to enable spell check; otherwise, false. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Gets or sets the form field value—the name of the selected combo box item. + + The name of the combo box item. + + + + Contains properties used to change the combo box field’s widget annotation without access to its inner structure. + + + + + Represents a command. + + + + + Represents a list of objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified object implementing the interface. + + A object implementing the System.Collections.IEnumerable interface that represents the command list. + + + + Lists the values specifying the compatibility mode of a document. + + + + + The document supports the ISO 32000-1:2008 standard. + + + + + The document supports the ISO 19005-1:2005 standard. + + + + + The document supports the ISO 19005-2:2011 standard. + + + + + The document supports the ISO 19005-3:2012 standard. + + + + + Lists values used to specify the horizontal alignment of the PDF page content. + + + + + The content is center-aligned. + + + + + The content is left-aligned. + + + + + The content is right-aligned. + + + + + Lists values used to specify the vertical alignment of the PDF page content. + + + + + The content is bottom-aligned. + + + + + The content is center-aligned. + + + + + The content is top-aligned. + + + + + Represents document creation options. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the compatibility mode of a document. + + A enumeration value that specifies the compatibility mode of a document. + + + + Gets or sets a value that specifies whether to prohibit embedding all fonts in a PDF document. + + true, to disable embedding all fonts in the PDF; otherwise false. + + + + Specifies whether to merge PDF/A documents. + + true, to merge document; otherwise, false. + + + + Gets or sets a list of font families that are not embedded in a document. + + A string list representing the collection of font families that are not embedded in a document. + + + + Allows you to build a signature for a document hash. + + + + + Initializes a new instance of the class with specified settings. + + An object that contains information about the external signature. + An object that contains information about a signature field. + + + + Initializes a new instance of the class with specified settings. + + An object that contains information about the external signature. + The name of the signature form field to apply an external signature. + + + + Initializes a new instance of the class with specified settings. + + An object that contains information about the external signature. + + + + The base class for destinations – references to a page with specific view parameters. + + + + + Gets the document page where the destination is located. + + The page where the destination is located. + + + + Gets the zero-based index of a page where the destination is located. + + The destination page index. + + + + Lists values that specify the content direction in the PDF document. + + + + + Left-to-right direction. + + + + + Right-to-left direction. + + + + + A document contained in a PDF file. + + + + + Provides access to the document’s interactive form (AcroForm) properties. + + A object. + + + + Provides access to the class that contains references to JavaScript actions which should be taken in response to some events. + + A object. + + + + Indicates whether copying or extracting text and graphics from the document is allowed (in support of accessibility to users with disabilities or for other purposes). + + true, if copying or extracting text and graphics from the document is allowed; otherwise false. + + + + Indicates whether adding and modifying text annotations and interactive form fields is allowed. + + true, if adding and modifying text annotations and interactive form fields is allowed; otherwise false. + + + + Indicates whether data extraction is allowed. + + true, if data extraction is allowed; otherwise false. + + + + Indicates whether inserting, rotating, or deleting pages and creating navigation elements such as bookmarks is allowed. + + true, if inserting, rotating, or deleting pages and creating navigation elements such as bookmarks is allowed; otherwise false. + + + + Indicates whether interactive form fields filling is allowed. + + true, if interactive form fields filling is allowed; otherwise false. + + + + Indicates whether document printing in high resolution is allowed. + + true, if document printing in high resolution is allowed; otherwise false. + + + + Indicates whether document modification and assembling is allowed. + + true, if document modification and assembling is allowed; otherwise false. + + + + Indicates whether document printing is allowed. + + true, if document printing is allowed; otherwise false. + + + + Attaches a ZUGFeRD XML to the document. + + A byte array that contains ZUGFeRD XML data. + An enumeration value that specifies the ZUGFeRD version. + An enumeration value that indicates the ZUGFeRD conformance level. + + + + Attaches a ZUGFeRD XML to the document. + + A byte array that contains ZUGFeRD XML data. + + + + Attaches a ZUGFeRD XML to the document. + + A stream that contains the ZUGFeRD XML data. + An enumeration value that specifies the ZUGFeRD version. + An enumeration value that indicates the ZUGFeRD conformance level. + + + + Attaches a ZUGFeRD XML to the document. + + A stream that contains the ZUGFeRD XML data. + + + + Gets or sets the name of the person who created the document. + + A value. + + + + Gets or sets the bookmarks that are used to navigate from one part of a document to another. + + A list of objects that are the collection of bookmarks. + + + + Gets the date and time when the document was created. + + A nullable structure that is a valid date-time offset. + + + + Gets or sets the name of the conforming product that created the original document, if this document was converted to PDF from another format. + + A value. + + + + Provides access to the document’s custom properties. + + A dictionary object containing custom properties. + + + + Gets named destinations for targets in the document. + + A dictionary, containing the objects, along with their key values. + + + + Gets the file attachments from a document. + + An object implementing the interface that represents the collection of s. + + + + Gets or sets the keywords associated with the document. + + A value. + + + + Gets or sets the language identifier that specifies the natural language for al document text. + + A object containing language identifier for all document text. + + + + Provides access to the document’s structure tree root dictionary. + + A DevExpress.Pdf.PdfLogicalStructure object. + + + + Provides access to the mark information dictionary that contains information about the document’s usage of Tagged PDF conventions. + + A DevExpress.Pdf.PdfMarkInfo object. + + + + Provides access to a stream that contains the document metadata. + + A object. + + + + Gets the date and time the document was modified. + + A nullable value that is the date and time of the file’s modification. + + + + Provides access to the document’s name dictionary. + + A object. + + + + Indicates whether or not to expedite the display of PDF documents containing XFA forms. + + true if the document shall be regenerated when the document is first opened; otherwise false. The default value is false. + + + + Indicates an action to be performed when a document is opened. + + A object that represents an action to be performed when a document is opened. + + + + Indicates a destination that shall be displayed when the document is opened. + + A object. + + + + Provides access to the document’s optional content properties. + + A object that represents the document’s optional content properties. + + + + Provides access to the outline dictionary that shall be the root of the document’s outline hierarchy. + + A object. + + + + Provides access to the array of output intent dictionaries that specify the color characteristics of output devices on which the document might be rendered. + + A collection of DevExpress.Pdf.PdfOutputIntent objects. + + + + Provides access to the number tree defining the page labeling for the document. + + A dictionary, containing the DevExpress.Pdf.PdfPageLabel objects, along with their integer key values. + + + + Indicates the page layout of the opened document. + + A enumeration value. + + + + Gets or sets the document’s page mode that specifies how to display the opened document (for example, whether to show page thumbnails or outlines automatically for a document). + + A enumeration value. The default value is UseNone. + + + + Obtains to the collection of document pages. + + A collection of objects. + + + + Provides access to the page-piece dictionary associated with the document. + + A dictionary, containing the DevExpress.Pdf.PdfPieceInfoEntry objects, along with their key values. + + + + Gets or sets the name of the conforming product that converted the original document to PDF from another format. + + A value. + + + + Embeds metadata in a document. + + An XMP packet. + + + + Embeds metadata in a document. + + An object that contains multiple XMP packets. + + + + Embeds metadata in a document. + + A string with metadata. + + + + Gets or sets the subject of a document. + + A value. + + + + Provides access to the array of thread dictionaries that contains the document’s article threads. + + A collection of DevExpress.Pdf.PdfArticleThread objects. + + + + Gets or sets the document’s title. + + A value. + + + + Gets or sets a value that specifies whether the document has been modified to include trapping information. + + A enumeration value. + + + + Indicates the version of the PDF specification to which the document conforms if later than the version specified in the file’s header. + + A DevExpress.Pdf.PdfFileVersion object. + + + + Gets or sets the document display options. + + An object that contains viewer preferences. + + + + Represents an action that is performed with a document. + + + + + Initializes a new PdfDocumentActions object with the specified settings. + + A target document. + + + + Gets an action performed when the document is closing. + + A object that represents the document closing action. + + + + Gets an action performed when the document is printed. + + A object that represents the action. + + + + Gets an action that is performed when the document is printing. + + A object that represents the action. + + + + Gets an action performed when the document is saved. + + A object that represents the action. + + + + Gets an action that is performed when the document is saving. + + A object that represents the action. + + + + A document area. + + + + + Initializes a new instance of the class with the specified settings. + + An integer value. This value is assigned to the PdfDocumentArea.PageNumber property. + A object. This value is assigned to the PdfDocumentArea.Area property. + + + + Returns a document area corresponding to the specified rectangle. + + A object. + + + + Creates a document area based on the specified start and end positions. + + A object. + A object. + A object. + + + + Indicates the page number corresponding to the current document area. + + An integer value that is the page number. + + + + Provides information about the PDF content type at a specific client point. + + + + + Initializes a new instance of the class with the specified settings. + + A object. This value is assigned to the PdfDocumentContent.DocumentPosition property. + A enumeration value. This value is assigned to the PdfDocumentContent.ContentType property. + true if the document content has been selected; otherwise false. This value is assigned to the PdfDocumentContent.IsSelected property. + + + + Indicates the type of the PDF content corresponding to a specific document point. + + A enumeration value. + + + + Indicates the document position corresponding to the PDF content. + + A object. + + + + Indicates whether or not the PDF content has been selected. + + true if the document content has been selected; otherwise false. + + + + Lists the values indicating the type of the PDF content corresponding to a specific document point. + + + + + The PDF content is an annotation. + + + + + The PDF content is an image. + + + + + The PDF content is not defined. + + + + + The PDF content is text. + + + + + Lists the values specifying permissions that are used to restrict or allow access to data extraction operations. + + + + + Allow PDF Viewers to access document contents by using the Viewer’s accessibility features. + + + + + Permit data extraction operations (copying or text and graphics extraction from the document) including access for the software that uses assistive technologies. + + + + + Prohibit data extraction operations (copying or text and graphics extraction from the document) including access for the software that uses assistive technologies. + + + + + Exposes a set of methods used to perform various operations on a PDF document without access to its inner structure. + + + + + Obtains a set of methods used to organize interactive forms. + + An object that exposes methods used to organize AcroForms. + + + + Flattens all document annotations. + + + + + Flattens all document annotations with the specified types. + + An array of annotation types. + + + + Flattens all document annotations that meet the specified criteria. + + Defines a set of criteria for the object. + + + + Flattens document annotations with the specified names. + + The annotation names. + + + + Returns all PDF page properties. + + A list of objects that contain page properties. + + + + Lists the values specifying permissions that are used to restrict or allow access to document interaction operations. + + + + + Permit interactive operations (adding or modifying text annotations, filling in interactive form fields, and creating or modifying interactive form fields) in the PDF document. + + + + + Prohibit interactive operations in the PDF document except filling existing form fields and document signing. + + + + + Prohibit all interactive operations (adding or modifying text annotations, filling in interactive form fields, and creating or modifying interactive form fields) in the PDF document. + + + + + Lists the values specifying permissions that are used to restrict or allow access to document modification operations. + + + + + Permit document modification and assembling. + + + + + Allow only document assembling such as inserting, rotating or deleting pages, as well as bookmark creation on the navigation pane. + + + + + Prohibit document modification and assembling. + + + + + Represents a point in the page coordinates of the PDF document. + + + + + Initializes a new instance of the class with the specified settings. + + An integer value. This value is assigned to the PdfDocumentPosition.PageNumber property. + A structure. This value is assigned to the PdfDocumentPosition.Point property. + + + + Indicates the number of a page corresponding to the hit point. + + An integer value that is the page number. + + + + Returns the hit point coordinates in a PDF. + + A structure. + + + + Lists the values specifying permissions that are used to restrict or allow access to document printing operations. + + + + + Permit document printing. + + + + + Prohibit document printing at the highest quality level. + + + + + Prohibit document printing. + + + + + This class supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Lists the available algorithms to encrypt a document. + + + + + Use the 128-bit AES (Advanced Encryption Standard) algorithm. + + + + + Use the 256-bit AES (Advanced Encryption Standard) algorithm. + + + + + Use the 128-bit ARC4 algorithm. + + + + + Contains settings to protect a PDF document with a password and user permissions. + + + + + Initializes a new instance of the class without encryption settings specified for a PDF document. + + + + + Specifies an algorithm to encrypt a PDF document. + + A enumeration value that specifies an encryption algorithm. + + + + Specifies the permissions on data extraction operations. + + A enumeration value. + + + + Specifies the permissions on interaction operations. + + A enumeration value. + + + + Specifies the permissions on document modification operations. + + A enumeration value. + + + + This property is now obsolete. To specify an owner password, use the PdfEncryptionOptions.OwnerPasswordString property instead. + + A object that is an owner password. + + + + Specifies an owner password that is used to allow full access to a document. + + A object that is an owner password. + + + + Specifies the permissions on printing operations. + + A enumeration value. + + + + This property is now obsolete. To specify a user password, use the PdfEncryptionOptions.UserPasswordString property instead. + + A object that is a user password. + + + + Specifies a user password that is used to protect opening the document. + + A object that is a user password. + + + + A file attached to a PDF document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets date when the file attachment was created in the document. + + A nullable structure that is a valid date-time offset. + + + + Gets or sets the data of the attached file represented as a byte array. + + The file content data represented as a byte array. + + + + Specifies the description for the attached file shown in the Attachments panel of a PDF Viewer. + + A string that is an attached file description. + + + + Gets or sets the attached file name. + + A string value that is the name of an attached file. + + + + Gets or sets the MIME type (content type) of the attached file. + + A that represents the MIME type of the attached file. + + + + Gets or sets the date and time of the attachment file’s last modification. + + A nullable value that is the date and time of the attachment file’s last modification. + + + + Gets or sets the relationship between the document and the attachment file. + + A enumeration value that specifies the relationship between the document and the attachment file. + + + + Gets the size of the file attachment. + + An integer value that is the file attachment size, in bytes. + + + + Contains members used to manage file attachment annotations without access to their inner structure. + + + + + Gets or sets the file attached to the annotation. + + The file attachment. + + + + Gets or sets the name of the file attachment annotation icon. + + The icon name. Use the PdfFileAttachmentAnnotationIconName class fields to specify a built-in icon. + + + + Contains names of built-in file attachment annotation icons. + + + + + The Graph icon name. + + The icon name. + + + + The Paper clip icon name. + + The icon name. + + + + The Pushpin icon name. + + The icon name. + + + + The Tag icon name. + + The icon name. + + + + Represents the file specification that gives the name of the target file in a standard format, and can also contain information related to one or more specific file systems. + + + + + Gets the date and time when the file was created. + + A nullable structure that is a valid date-time offset. + + + + Gets the descriptive text associated with the file specification. + + A string that is a file specification description. + + + + Gets the data of the file specification represented as a byte array. + + The file content data represented as a byte array. + + + + Returns the file name. + + A value that is the file name. + + + + Gets the name of the file system that is used to interpret this file specification. + + A value that is the name of the file system. + + + + Gets the zero-based index associated with the file specification. + + An integer value that is the zero-based index associated with the file specification. + + + + Gets the MIME type (content type) of the file. + + A that represents the MIME type of the file. + + + + Gets the date and time of the file’s last modification. + + A nullable value that is the date and time of the file’s last modification. + + + + Gets the relationship between the document and the file. + + A enumeration value that specifies the relationship between the document and the file. + + + + Gets the size of the file attachment. + + An integer value that is the file attachment size, in bytes. + + + + Represents an image filter. + + + + + Lists values that indicate the annotation type used in the filter. + + + + + Insertion caret. + + + + + Circle annotation. + + + + + Custom annotation. + + + + + File attachment. + + + + + Free text annotation. + + + + + Text highlight. + + + + + Ink annotation (a freehand “scribble” composed of one or more disjoint paths). + + + + + Line annotation. + + + + + Polygon annotation. + + + + + Polyline annotation. + + + + + Redaction annotation. + + + + + Audio attachment. + + + + + Rectangle annotation. + + + + + Text squiggly underline. + + + + + Stamp annotation. + + + + + Text strikeout. + + + + + Text annotation. + + + + + Text underline. + + + + + A destination that displays a page’s bounding box that fits the document window. + + + + + Initializes a new instance of the class with the the specified parameters. + + The page to which the destination should refer. + + + + A destination that positions a specific Y coordinate at the top left corner of the document window, and zooms a page’s bounding box so that it fits the window horizontally. + + + + + Initializes a new instance of the class with the specified parameters. + + The page to which the destination should refer. + the Y coordinate that is positioned at the top left corner of the document window. + + + + Gets the Y coordinate that is positioned at the top left corner of the document window. + + The Y coordinate in the user coordinate system. + + + + A destination that positions a specific X coordinate at the top left corner of the document window, and zooms a page’s bounding box so that it fits the window vertically. + + + + + Initializes a new instance of the class with the specified page and the left horizontal coordinate positioned at the left edge of the window. + + A object that is the PDF page. + A nullable double value that is the left horizontal page coordinate. + + + + Gets the X coordinate that is positioned at at the top left corner of the document window. + + The X coordinate in the user coordinate system. + + + + A destination that displays a page that fits the document window. + + + + + Initializes a new instance of the class with the specified parameters. + + The page on which the destination should refer. + + + + A destination that positions a specific Y coordinate at the top left corner of the document window, and zooms a page so that it fits the window horizontally. + + + + + Initializes a new instance of the class with the specified parameters. + + The page to which the destination should refer. + the Y coordinate that is positioned at at the top left corner of the document window. + + + + Gets the Y coordinate that is positioned at the top left corner of the document window. + + The Y coordinate in the user coordinate system. + + + + A destination that displays a specific page rectangle in the document window. + + + + + Initializes a new instance of the class with the specified parameters. + + The page to which the destination should refer. + The rectangle to fit into the document window. + + + + Gets a rectangle that is fit into the document window. + + The rectangle in the user coordinate system. + + + + A destination that positions a specific X coordinate at the top left corner of the document window, and zooms a page so that it fits the window vertically. + + + + + Initializes a new instance of the class with the specified parameters. + + The page to which the destination should refer. + The X coordinate that is positioned at at the top left corner of the document window. + + + + Gets the X coordinate that is positioned at at the top left corner of the document window. + + The X coordinate in the user coordinate system. + + + + A font assigned to a document text. + + + + + The PostScript name of the font. + + A value. + + + + Provides access to the PDF font options. + + A object. + + + + The PostScript name of the font. + + A value, specifying the font name. + + + + Specifies a font subset. + + A value. + + + + Converts PDF character codes to Unicode values. + + A object, providing a CMap table that maps character codes to Unicode values. + + + + Provides the PDF font options. + + + + + Indicates the maximum height above the baseline reached by glyphs in this font. + + A value. + + + + Indicates the average width of glyphs in the font. + + A value. + + + + The vertical coordinate of the top of flat capital letters, measured from the baseline. + + A value. + + + + Indicates the character names defined in a font subset. + + A list of values. + + + + Provides access to a dictionary identifying which CIDs are present in the CIDFont file. + + A dictionary, containing the System.Int16 objects, along with their key values. + + + + Indicates the maximum depth below the baseline reached by glyphs in this font. + + A value. + + + + Provides access to a collection of flags defining various characteristics of the font. + + A enumeration value. + + + + Indicates a rectangle, expressed in the glyph coordinate system, that shall specify the font bounding box. + + A object. + + + + Indicates the preferred font family name. + + A value. + + + + Indicates the PostScript name of the font. + + A value. + + + + Indicates the font stretch value. + + A enumeration value. + + + + Indicates the weight (thickness) component of the fully-qualified font name or font specifier. + + An integer value. + + + + The angle, expressed in degrees counterclockwise from the vertical, of the dominant vertical strokes of the font. + + A value. + + + + Indicates the spacing between baselines of consecutive lines of text. + + A value. + + + + Indicates the maximum width of glyphs in the font. + + A value. + + + + The width to use for character codes whose widths are not specified in a font dictionary’s Widths array. + + A value. + + + + Indicates the thickness, measured vertically, of the dominant horizontal stems of glyphs in the font. + + A value. + + + + Indicates the thickness, measured horizontally, of the dominant vertical stems of glyphs in the font. + + A value. + + + + Indicates the font’s X-height: the vertical coordinate of the top of flat nonascending lowercase letters (like the letter x), measured from the baseline, in fonts that have Latin characters. + + A value. + + + + Lists the values that correspond to flags defining various characteristics of the font. + + + + + “0x10000” + + + + + “0x00001” + + + + + “0x40000” + + + + + “0x00040” + + + + + “0x00000” + + + + + “0x00020” + + + + + “0x00008” + + + + + “0x00002” + + + + + “0x20000” + + + + + “0x00004” + + + + + Lists the font stretch values. + + + + + “Condensed” + + + + + “Expanded” + + + + + “ExtraCondensed” + + + + + “ExtraExpanded” + + + + + “Normal” + + + + + “SemiCondensed” + + + + + “SemiExpanded” + + + + + “UltraCondensed” + + + + + “UltraExpanded” + + + + + Lists the form field’s font styles. + + + + + Bold text. + + + + + Italic text. + + + + + Normal text. + + + + + Text with a line through the middle. + + + + + Underlined text. + + + + + Represents a PDF document form. + + + + + Gets a document rectangle in the form coordinate system of the form’s bounding box. + + A object that is the document rectangle. + + + + Returns the PDF form commands. + + A collection of objects. + + + + Gets the modification date to be sure which of the application data dictionaries it contains corresponds to the current content of the form. + + A nullable structure that is a valid date-time offset. + + + + Returns a transformation matrix which maps the form space into user space. + + A DevExpress.Pdf.PdfTransformationMatrix object that is the PDF transformation matrix. + + + + Gets a page-piece dictionary which holds private product data. + + A dictionary, containing the DevExpress.Pdf.PdfPieceInfoEntry objects, along with their key values. + + + + Gets an integer key of the form entry in the structural parents tree. + + A nullable integer value specifying the key of the form entry. + + + + Contains data values stored in the PDF Form. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the predefined stream and data format. + + A class descendant containing a file with the form data (Fdf, Txt, Xfdf or Xml format). + A enumeration value specifying the format in which interactive form values are stored. + + + + Initializes a new instance of the class with the predefined stream. + + A class descendant containing a file with the interactive form data (Fdf, Txt, Xfdf or Xml format). + + + + Initializes a new instance of the class with the predefined file name and data format. + + A containing the path to a file with the interactive form data (Fdf, Txt, Xfdf or Xml format). + A enumeration value specifying the format in which interactive form values are stored. + + + + Initializes a new instance of the class with the predefined file name. + + A containing the path to a file with the interactive form data (Fdf, Txt, Xfdf or Xml format). + + + + Retrieves the form field type. + + An enumeration value that indicates the form field type. + + + + Returns the child field names for a particular tree node. + + A list of child field names for a particular tree node. + + + + Returns an individual field by its name on the PDF Form. + + A string representing the field name. + A object. + + + + Obtains a list of form field items. + + A list of form field items. + + + + Returns the name of the field represented by this object. + + A value. + + + + Saves the interactive form data to a stream in the specified form data format. + + The stream to which the interactive form should be saved. + An enumeration value that indicates the interactive form data format. + + + + Saves the interactive form data into a file in the specified form data format. + + A file path and file name. + An enumeration value that indicates the form data format. + + + + Specifies a value to the interactive form field represented by this object. + + A class descendant. + + + + Lists formats allowed for PDF Form data values. + + + + + Data is represented as FDF (Forms Data Format). + + + + + Data is represented as text. + + + + + Data is represented as XFDF (XML Forms Data Format). + + + + + Data is represented as XML. + + + + + Base class for all form field facades. + + + + + Retrieves the AcroForm that contains the form field. + + An object that exposes methods used to organize AcroForms. + + + + Gets or sets whether to export the form field if it is associated with a Submit A Form action. + + true to export the field with a submit-form action; otherwise, false. + + + + Gets or sets the form field flags. + + Enumeration values that indicate the document-level characteristics. + + + + Flattens the form field. + + + + + Gets the form field’s full name. + + The form field name. + + + + Returns an enumerator that iterates through the instance. + + A for the instance.’ + + + + Gets or sets whether the form field is read-only. + + true if the form field is read-only; otherwise, false. + + + + Rebuilds the form field’s appearance. + + + + + Gets or sets whether to force users to complete the form field. + + true to mark the form field as required; otherwise, false. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + A generic form field facade class that allows you to retrieve the annotation widget properties. + + A object that provides the class descendant (the class) with access to the form field widget. + A PdfInteractiveFormField object that provides the class descendant (the class) with access to inner form field properties. + + + + Retrieves field’s inner properties. + + A PdfInteractiveFormField descendant object that contains inner field properties. + + + + Returns an enumerator that iterates through the instance. + + A for the instance. + + + + Retrieves properties of each annotation widget related to the form field. + + A list of objects that contain widget properties. + + + + Represents an interactive form field item. + + + + + Gets a form field item’s display value. + + The form field item’s display value. + + + + Determines whether the specified object is equal to the current PdfFormFieldItem object. + + A point to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns a number that identifies the object instance. + + The hash code for the current object. + + + + Retrieves the value of the form field item. + + The form field item value. + + + + Lists values used to specify the interactive from field type. + + + + + Check box. + + + + + Combo box. + + + + + List box. + + + + + Base field in a field group. + + + + + Push button. + + + + + Radio group. + + + + + Signature form field. + + + + + Text form field. + + + + + Unknown type. + + + + + Contains members used to manage free text annotations without access to their inner structure. + + + + + Gets or sets the intensity of the border effect. + + Border effect intensity (from 0 to 2). + + + + Gets or sets the effect applied to the annotation border. + + Indicates the border effect. + + + + Gets or sets the border style of the free text annotation. + + Indicates the annotation border style. + + + + Gets or sets the border width of the free text annotation. + + The annotation border width. + + + + Specifies whether to format the annotation’s text as bold. + + true to make text bold; otherwise, false. + + + + Specifies the annotation’s font color. + + The font color. + + + + Specifies whether to format the annotation’s text as italic. + + true to make text italic; otherwise, false. + + + + Specifies the annotation’s font name. + + The font name. + + + + Specifies the annotation’s font size. + + The font size. + + + + Gets or sets the intent of a free text annotation. + + Indicates the annotation intent type. + + + + Gets or sets the annotation’s border color. + + The annotation border color. + + + + Gets or sets the annotation’s rotation angle. The annotation is rotated counterclockwise. + + The degree of rotation (from 0 to 360) in multiples of 90. + + + + Adds a callout line to the free text annotation. + + Indicates the ending style of the callout line. + The start point of the callout line. + The knee point of the line curve. + The end point of the callout line. + + + + Adds a callout line to the free text annotation. + + Indicates the ending style of the callout line. + The start point of the callout line. + + + + Gets or sets how the text is aligned in the free text annotation. + + Indicates the text justification type. + + + + Gets or sets the text box rectangle. + + The annotation text rectangle. + + + + Specifies the intent of free text annotations. + + + + + The annotation is intended to function as a free text annotation (text box comment). + + + + + The annotation is intended to function as a callout annotation. + + + + + The annotation is intended to function as click-to-type or a typewriter object. This type of annotation has no callout or border. + + + + + An action that changes the view to a specified destination (page, location, and magnification factor). + + + + + Initializes a new PdfGoToAction object with specified settings. + + A target document. + A PdfDestination object that is a destination (a particular view of a document). + + + + Contains values that specify how to interpret a PointF object passed to the PdfGraphics.DrawString methods as a parameter. + + + + + The point is on the text baseline. + + + + + The point is the top left corner of the text rectangle. + + + + + Specifies the type of display for hot-key prefixes that relate to text. + + + + + Do not display the hot-key prefix. + + + + + No hot-key prefix. + + + + + Contains properties that define how to display the button’s icon within the annotation rectangle of its widget annotation. + + + + + Gets a value that indicates whether the button appearance is scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border. + + true, to fit fully within the bounds of the annotation otherwise, false. The default value is false. + + + + Gets the horizontal leftover of the icon within an annotation rectangle. + + A double value that is the horizontal leftover of the icon within an annotation rectangle. + + + + Gets the circumstances under which the icon shall be scaled inside the annotation rectangle. + + A enumeration value that lists the circumstances for scaling an icon. + + + + Get the type of icon scaling. + + A enumeration value that is the icon scaling type. + + + + Gets the vertical leftover of the icon within an annotation rectangle. + + A double value that is the vertical icon leftover within the annotation rectangle. + + + + Lists conditions under which the icon is scaled inside the annotation rectangle. + + + + + Always scale. + + + + + Scale only when the icon is bigger than the annotation rectangle. + + + + + Never scale. + + + + + Scale only when the icon is smaller than the annotation rectangle. + + + + + Lists the type of icon scaling in the widget annotation rectangle. + + + + + Scale the icon to fill the annotation rectangle exactly, ignoring its original aspect ratio. + + + + + Scale the icon to fit the width or height of the annotation rectangle and maintain the icon’s original aspect ratio. + + + + + Represents an image in the PDF document. + + + + + Gets the number of bits used to represent each color component. + + An integer value that is the number of bits used to represent each color component. + + + + Gets a color key mask. + + A collection of objects that represents a range of colors to be masked out. + + + + Gets the color space in which image samples shall be specified. + + A object that is the color space required for an image. + + + + Gets the image data. + + The image data represented as a byte array. + + + + Gets a collection of numbers describing how to map image samples into the range of values appropriate for the image’s color space. + + A collection of objects. + + + + Gets image filters. + + A collection of objects. + + + + Gets the height of the image, in pixels. + + An integer value that is the image height. + + + + Gets the name of a color rendering intent to be used in rendering the image. + + A nullable enumeration value that is the name of a color rendering intent. + + + + Gets a value that indicates whether image interpolation shall be performed. + + true, if image interpolation should be performed while rendering this image; otherwise, false. + + + + Gets a value that determines whether an image is a stencil mask image. + + true, if an image is a stencil mask image; otherwise, false. + + + + An image XObject defining an image mask to be applied to this image. + + A that is an image mask to be applied to this image. + + + + Gets a collection of component values specifying the matte color with which the image data in the parent image shall have been preblended. + + A collection of objects. + + + + Gets a subsidiary image XObject defining a soft-mask image that shall be used as a source of the mask shape or mask opacity values in the transparent imaging model. + + A object that represents a subsidiary image XObject defining a soft-mask image. + + + + Gets the width of the image, in pixels + + An integer value that is the image width. + + + + Contains members used to manage ink annotations without access to their inner structure. + + + + + Gets or sets the annotation border style. + + Indicates the annotation border style. + + + + Gets or sets the width of the annotation border. + + The annotation border width. + + + + Gets a list of points that compose the annotation. + + The list of annotation points. + + + + An interactive form (AcroForm) that represents a collection of fields for gathering information interactively from the user. + + + + + Gets a collection of default appearance commands. + + A collection of objects. + + + + Gets the default justification that is used in displaying the annotation’s text. + + A enumeration value that represents the default text justification. + + + + Gets the document’s root fields. + + A collection of objects that contain the document’s root fields. + + + + Obtains the interactive form field by its name. + + The form field name. + An interactive from field with the specified name. + + + + Gets a value that indicates whether to construct appearance streams and appearance dictionaries for all widget annotations in the document. + + true to construct appearance streams and appearance dictionaries for all widget annotations; otherwise false. Default value: false. + + + + Gets flags specifying various document-level characteristics related to signature fields. + + A enumeration values that represent the signature flags. + + + + Gets an XFA form. + + A object that represents the XFA form. + + + + Represents interactive form field data (e.g., text boxes, radio buttons, combo boxes) in a document. + + + + + Provides access to actions that define the field’s behavior in response to various trigger events. + + A object that contains interactive form fields actions. + + + + Gets an alternate name specified for an interactive form field. + + A value that is the alternate name for an interactive form field. + + + + Gets the appearance commands for an interactive form field. + + A collection of objects that represent appearance commands. + + + + Gets the default style string. + + A value that represents the name of the default style applied to the interactive form. + + + + Gets or sets whether to export the field if it is associated with a Submit A Form action. + + true to export the field with a submit-form action; otherwise, false. + + + + Gets or sets flags specifying various document-level characteristics related to interactive form fields. + + enumeration values that represent flags specifying various document-level characteristics. + + + + Provides access to the contents and properties of a document’s interactive form. + + A object that represents the document’s interactive form. + + + + Gets the collection of interactive form field children. + + A collection of the objects containing the immediate children of the interactive form field. + + + + Gets the mapping name that is used when exporting interactive form field data from the document. + + A value that represents the mapping name. + + + + Gets the partial field name. + + A value that is the partial field name. + + + + Gets the parent of the field in the interactive form field hierarchy. + + A object that represents the parent of the interactive form field. + + + + Gets or sets whether the form field is read-only. + + true if the form field is read-only; otherwise, false. + + + + Gets or sets whether to force users to complete the form field. + + true to mark the form field as required; otherwise, false. + + + + Gets the rich text string that contains formatting (style) information. + + A value that is the rich text data. + + + + Gets the form of quadding (justification) that is used in displaying the text. + + A object that represents the form of text justification. + + + + Retrieves the form field type. + + An enumeration value that indicates the form field type. + + + + Gets the widget annotation associated with the interactive form field. + + A object that is the widget annotation. + + + + Represents an action that is performed with the interactive form fields. + + + + + Gets a JavaScript action that is executed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box. + + A object that represents the JavaScript action that is executed when the user modifies a character. + + + + Gets a JavaScript action that is executed before the field is formatted to display its value. + + A object that represents the JavaScript action that is executed before the field is formatted to display its value. + + + + Gets a JavaScript action that is performed to recalculate the value of this field when another field is changed. + + A object that represents the JavaScript action performed to recalculate the value of this field. + + + + Gets a JavaScript action that is performed when the field’s value is changed. + + A object that represents the JavaScript action performed when the field’s value is changed. + + + + Represents flags specifying various document-level characteristics related to interactive form fields. + + + + + This flag is set only if the PdfTextFormField.MaxLen entry is present in the text field dictionary and if the PdfInteractiveFormFieldFlags.Multiline, PdfInteractiveFormFieldFlags.Password, and PdfInteractiveFormFieldFlags.FileSelect flags are clear. If this flag is active, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs. + + + + + If this flag is active, the field is a combo box. Otherwise, the field is a list box. + + + + + If the flag is set, the new value shall be committed once a selection is made. Otherwise, the new value is not committed until the end user exits the field. + + + + + If this flag is set, the field shall not scroll to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling. + + + + + If this flag is set, text entered in the field shall not be spell-checked. This flag shall not be used unless the PdfInteractiveFormFieldFlags.Combo and PdfInteractiveFormFieldFlags.Edit flags are both set. + + + + + If this flag is set, the combo box shall include an editable text box as well as a drop-down list. Otherwise, the combo box shall include only a drop-down list. This flag shall be used only if the PdfInteractiveFormFieldFlags.Combo flag is set. + + + + + If this flag is set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field. + + + + + If this flag is set, the field may contain multiple lines of text. Otherwise, the field’s text shall be restricted to a single line. + + + + + If this flag is set, more than one of the field’s option items may be selected simultaneously. Otherwise, only one item shall be selected. + + + + + If this flag is set, the field shall not be exported by a submit-form action. + + + + + If active, deactivates all other options. + + + + + This flag is used for radio buttons only. If active, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. Otherwise, clicking the selected button deselects it, leaving no button selected. + + + + + If this flag is set, the field is intended for entering a secure password that should not be echoed visibly on the screen. Characters typed from the keyboard shall instead be echoed in an unreadable form, such as asterisks or bullet characters. + + + + + If this flag is set, the field is a pushbutton that does not retain a permanent value. + + + + + If this flag is set, the field is a set of radio buttons. Otherwise, the field is a check box. This flag may be set only if the PdfInteractiveFormFieldFlags.PushButton flag is clear. + + + + + If this flag is set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. Otherwise, the buttons are mutually exclusive. + + + + + If this flag is set, the end user may not change the value of the field. Any associated widget annotations will not interact with the end user. This flag is useful for fields whose values are computed or imported from a database. + + + + + If this flag is set, the field shall have a value at the time it is exported by a submit-form action. + + + + + If this flag is set, the value of this field shall be a rich text string. + + + + + If the flag is set, the field’s option items shall be sorted alphabetically. + + + + + Represents a JavaScript action that executes a script that is written in the JavaScript programming language. + + + + + Initializes a new PdfGoToAction object with specified settings. + + A string value that is the JavaScript code. + A target document. + + + + Gets a JavaScript script. + + A value that is the JavaScript script. + + + + Serves as the base for classes that allow jumping to a destination in the current document () or a destination in another PDF file (). + + + + + Gets the destination that will be displayed when the action is performed. + + A object that represents the destination. + + + + Contains members used to manage line annotations without access to their inner structure. + + + + + Gets or sets the style of the line’s end point. + + Indicates the line start style. + + + + Gets or sets the style of the line’s start point. + + Indicates the line start style. + + + + Provides the style settings used to paint the lines in a document. + + + + + Creates a dashed guideline style using the dash length, gap length, and dash phase. + + A double value that is the dash length. + A double value that is the gap length. + A double value that is the dash phase. + A object that is the dashed guideline style. + + + + Creates a dashed guideline style using the dash pattern and dash phase. + + An array of double values that represents the dash pattern. + A double value that is the dash phase. + A object that is the dashed guideline style. + + + + Create the solid guideline style. + + A object that represents the created style. + + + + Gets a line dash pattern specified by a dash array and a dash phase. + + An array of double values that represent the line dash pattern. + + + + Gets the dash phase, which specifies the distance into the dash pattern at which to start the dash. + + A double value that is the dash phase. + + + + Gets a value that indicates whether a line is dashed. + + true, if the line is dashed; otherwise, false. + + + + Represents the link annotation (a hypertext link to a destination) in a document. + + + + + Provides access to the link annotation action being executed. + + A object that is an action that is performed with the link annotation. + + + + Gets the annotation border style specifying the line width and dash pattern to be used in drawing the annotation’s border. + + A object that contains properties to specify the annotation border style. + + + + Gets a destination that will be displayed when the annotation is activated. + + A object that is the link annotation destination. + + + + Gets or sets the annotation’s highlight mode activated when the mouse button is pressed or held down inside the annotation’s active area. + + Indicates the annotation highlight mode. + + + + Gets the region in which the annotation link should be activated. + + A list of objects that represent the coordinates of quadrilaterals in the default user space that comprises the region. + + + + Gets a URI action that is associated with the annotation. + + A object that is the URI action. + + + + Contains members used to manage link annotations without access to their inner structure. + + + + + Gets or sets the style of the annotation border. + + Indicates the annotation border style. + + + + Gets or sets the width of the annotation border. + + The annotation border’s width. + + + + Gets a destination (a reference to a page with specific view parameters) associated with the annotation. + + The destination to which the link annotation refers. + + + + Gets a URI associated with an annotation. + + The URI associated with the annotation. + + + + Gets or sets the annotation’s highlight mode activated when the mouse button is pressed or held down inside the annotation’s active area. + + Indicates the annotation highlight mode. + + + + Sets a destination (a reference to a page with specific view parameters) associated with an annotation. + + The destination to which the link annotation refers. + + + + Sets a URI string associated with the annotation. + + A URI string to which the link annotation refers. + + + + Contains a set of properties used to manage list box form fields without access to their inner structure. + + + + + Gets or sets whether to enable users to select multiple items in the list box. + + true to enable multiple selection; otherwise, false. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Gets or sets list box values—currently selected list box item names. + + A list of list box item names. + + + + Contains properties used to change the list box field’s widget annotation without access to its inner structure. + + + + + Represents a markup annotation that is used to mark up PDF documents. + + + + + Gets the date and time when the annotation was created in the document. + + A nullable structure that is a valid date-time offset. + + + + Gets the type into which the annotation falls in the Type filter. + + An enumeration value that indicates the annotation type. + + + + Gets an annotation that requires a reply to another annotation. + + A object that represents an annotation that requires a reply to another annotation. + + + + Gets the name that describes the intent of the markup annotation. + + A value that is the name that describes the markup annotation intent. + + + + Gets the opacity value that is used in painting the annotation. + + A double value that is the annotation opacity. + + + + Gets a pop-up annotation for entering or editing the text associated with this annotation. + + A object that is the popup annotation. + + + + Gets a name specifying the relationship (the reply type) between this annotation and the annotation obtained in the PdfMarkupAnnotation.InReplyTo property. + + A enumeration value that represents the annotation reply type. + + + + Gets a rich text that is displayed in the pop-up window when the annotation is opened. + + A string value that represents the rich text. + + + + Gets a description of the subject being addressed by the annotation. + + A string value that is the text representing a short description of the subject. + + + + Gets the text displayed in the title bar of the annotation’s pop-up window when the annotation is open and active. + + A string value that is the annotation title. + + + + Represents a comment added to an annotation. + + + + + Creates a nested comment. + + The comment’s author. + The comment’s text. + The nested comment. + + + + Adds a review to the comment. + + The review’s author. + Review status. + + + + Adds a review to the comment. + + The review’s author. + The review status. + + + + Specifies the comment’s author. + + The comment’s author. + + + + Removes all reviews applied to the comment. + + + + + Gets or sets the comment contents. + + The comment contents. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise, false. + + + + Returns a number that identifies the object instance. + + An integer that identifies the color instance. + + + + Gets or sets the date and time when the comment wae last modified. + + The comment’s modification date. + + + + Removes the specified nested comment. + + The comment that should be removed. + true, if the comment is removed successfully; otherwise, false. + + + + Retrieves all nested comments. + + A list of comments. + + + + Retrieves the reviews applied to the comment. + + A collection of reviews. + + + + Gets or sets the subject of the comment. + + The comment’s subject. + + + + Represents markup annotations. + + + + + Adds a comment to the document annotation. + + The comment’s author. + The comment’s text. + The annotation comment. + + + + Adds a review to the annotation. + + The author of the review. + The review status. + + + + Adds a review to the annotation. + + The author of the review. + The review status. + + + + Specifies the annotation author. + + The annotation’s author. + + + + Removes all reviews from the annotation. + + + + + Specifies the date and time when the annotation was created. + + The date and time when the annotation was created. + + + + Specifies the annotation’s opacity. + + A double value that is the annotation opacity (from 0 to 1). + + + + Removes the specific comment from the annotation. + + The comment to be removed. + true, if the comment is deleted successfully; otherwise, false. + + + + Obtains the annotation comments. + + A list of comments added to the annotation. + + + + Obtains the annotation reviews. + + A collection of reviews applied to the annotation. + + + + Specifies a short description of the subject being addressed by the annotation. + + A short description of the subject. + + + + Contains extension methods for the class. + + + + + Casts the object to the object. + + Current PdfMarkupAnnotationData object. + The text annotation. + + + + Casts the object to the object. + + Current PdfMarkupAnnotationData object. + The text markup annotation. + + + + Contains a set of properties used to manage markup annotations without access to their inner structure. + + + + + Adds a comment to the document annotation. + + The comment’s author. + The comment’s text. + The annotation comment. + + + + Adds a review to the annotation. + + The author of the review. + The review status. + + + + Adds a review to the annotation. + + The author of the review. + The review status. + + + + Specifies the annotation author. + + The annotation’s author. + + + + Removes all reviews from the annotation. + + + + + Specifies the date and time when the annotation was created. + + The date and time when the annotation was created. + + + + Specifies the annotation’s opacity. + + A double value that is the annotation opacity (from 0 to 1). + + + + Removes specific comment from the annotation. + + The comment to be removed. + true if the comment is deleted successfully; otherwise, false. + + + + Obtains annotation comments. + + A list of comments added to the annotation. + + + + Obtains annotation reviews. + + A collection of reviews applied to the annotation. + + + + Specifies a short description of the subject being addressed by the annotation. + + A short description of the subject. + + + + List values that specify the relationship (the “reply type”) between one annotation and another. + + + + + The annotation is grouped with the annotation obtained in the PdfMarkupAnnotation.InReplyTo property. + + + + + The annotation is considered a reply to the annotation obtained in the PdfMarkupAnnotation.InReplyTo property. + + + + + Represents the review added to an annotation or comment. + + + + + Retrieves the annotation’s author. + + The annotation’s author. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise, false. + + + + Returns a number that identifies the object instance. + + An integer that identifies the color instance. + + + + Retrieves the review status. + + The review status. + + + + Represents global information about the document such as the document’s title, author, and creation and modification dates. + + + + + Gets the data for the document components. + + A string value that represents the data of document components. + + + + Represents a named action. + + + + + The name of the named action that should be performed. + + A value that is the name of the action. + + + + Stores names of various PDF entities. + + + + + Provides access to a dictionary of annotation appearances. + + A dictionary, containing the objects, along with their key values. + + + + Gets embedded files in which the destination is located. + + A dictionary, containing the DevExpress.Pdf.PdfFileSpecification objects, along with their key values. + + + + Gets Java Script actions found in the document. + + A dictionary, containing the objects, along with their System.String key values. + + + + Gets page destinations for targets in the document. + + A dictionary, containing the objects, along with their key values. + + + + Provides access to a dictionary of page names. + + A dictionary, containing the objects, along with their key values. + + + + Gets a web capture content dictionary, which maps digital identifiers (IDs) to PDF objects such as pages and forms. + + A dictionary, containing the DevExpress.Pdf.PdfSpiderSet objects, along with their key values. + + + + Gets a web capture content dictionary which maps URLs to PDF objects such as pages and forms. + + A dictionary, containing the DevExpress.Pdf.PdfSpiderSet objects, along with their key values. + + + + Lists values that specify how the document page is displayed in windowed mode. + + + + + Only pages are displayed. Bookmarks, Attachments, Page Thumbnails, and Layers panels are hidden. + + + + + The pages and optional content group panel (the Layers panel) are displayed. + + + + + The pages and the Bookmarks panel are displayed. + + + + + The pages and the Page Thumbnails panel are displayed. + + + + + Represents content in a PDF document that can be selectively viewed or hidden. + + + + + Represents different presentations of a document’s optional content groups. + + + + + Gets a state value that is used to initialize the states of all the optional content groups in a document when this configuration is applied. + + A enumeration value that initializes the states of all the optional content groups in a document when this configuration is applied. + + + + Gets the name of the application or feature that created this content configuration. + + A value that is the name of the application or feature. + + + + Gets intent names that are used to determine which optional content groups’ states to consider and which to ignore in calculating the visibility of content. + + A enumeration values that list intent names. + + + + Gets a collection of optional content groups that shall be locked when this configuration is applied. + + A collection of objects that represent optional content groups that shall be locked when this configuration is applied + + + + Gets the name of the optional content configuration. + + A value that is the configuration name. + + + + Gets the collection of optional content groups whose state shall be set to Off when this configuration is applied. + + A collection of objects that represent optional content groups whose state shall be set to Off when this configuration is applied. + + + + Gets the collection of optional content groups whose state shall be set to On when this configuration is applied. + + A collection of objects that represent optional content groups whose state shall be set to On when this configuration is applied. + + + + Gets the order for presentation of optional content groups. + + A object that is the order for presentation of optional content groups. + + + + Gets a name specifying which optional content groups in the PdfOptionalContentConfiguration.Order property will be displayed to the user. + + enumeration values that list the optional content order. + + + + Gets a collection consisting of one or more collections, each of which represents a collection of optional content groups whose states shall be intended to follow a radio button paradigm. + + A collection of objects. + + + + Gets a collection of usage applications specifying which usage categories will be used to automatically manipulate the state of optional content groups. + + A collection of objects. + + + + Represents the optional content group that is used to control the visibility of graphic objects. + + + + + Gets a single intent name containing any combination of names. + + A enumeration values that list intent names. + + + + Gets the name of the optional content group. + + A value that is the optional content group name. + + + + Gets the content usage describing the nature of the content controlled by the group. + + A object that represents the content usage. + + + + Lists names that are used to determine which optional content group states to consider and which to ignore in calculating the visibility of content. + + + + + Indicates the set of all intents, including those not yet defined. + + + + + Indicates the Design intent name. + + + + + Indicates the View intent name. + + + + + Represents the order for presentation of optional content groups. + + + + + Gets items of the optional content that will be displayed in the user interface. + + A collection of objects that represent items of the optional content. + + + + Gets a name of the optional content group displayed in the user interface. + + A value that is the name of the optional content group. + + + + Lists values that specify which optional content groups in the PdfOptionalContentConfiguration.Order property will be displayed to the user. + + + + + Display all groups in the PdfOptionalContentConfiguration.Order property. + + + + + Display only those groups in the PdfOptionalContentConfiguration.Order property that are referenced by one or more visible pages. + + + + + Contains a list of all the optional content groups in the document, as well as information about the default and alternate configurations for optional content. + + + + + Gets a collection of alternate optional content configurations. + + A collection of objects. + + + + Gets the default viewing optional content configuration. + + A object that is the default optional content configuration. + + + + Gets a collection of all the optional content groups in the document. + + A collection of objects. + + + + Represents a collection of optional content groups whose states are intended to follow a radio button paradigm. + + + + + Initializes a new instance of the class with the default settings. + + + + + Lists the states of all the optional content groups in a document when the optional content configuration is applied. + + + + + The states of all groups will be turned OFF. + + + + + The states of all groups will be turned ON. + + + + + The states of all groups will be left unchanged. + + + + + Represents an optional content group’s usage that contains information describing the nature of the content controlled by the group. + + + + + Gets a value that is used by the creating application to store application-specific data associated with this optional content group. + + A PdfOptionalContentUsageCreatorInfo object that contains information that is used by the creating application. + + + + Gets a value that indicates the recommended state for content in this group when the document is saved to a format that does not support optional content (for example, a raster image format). + + A enumeration member that indicates the recommended state for content in this group. + + + + Gets a value that indicates whether a partial match exists between the system language and the language strings in the entire usage. + + true, if the language is preferred; otherwise false. + + + + Gets the language of the content controlled by this optional content group. + + A object containing the language of the content. + + + + Gets the magnification factor below which the content in this optional content group is best viewed. + + A double value that is the magnification factor below which the group will be ON. + + + + Gets the minimum magnification factor at which the content in this optional content group is best viewed. + + A double value that is the minimum magnification factor at which the group will be ON. The default value: 0. + + + + Gets a value indicating that the group contains a pagination artifact. + + A PdfPageElement enumeration value. + + + + Gets a name specifying the kind of content controlled by the group (e.g.,Trapping, PrintersMarks and Watermark). + + A value that is the name specifying the kind of content controlled by the group. + + + + Gets a value that indicates whether the group is set to either the ON or OFF state when the document is printed. + + A enumeration member that specifies whether the group is set to the state when the document is printed. + + + + Gets a value that indicates whether the group is set to either the ON or OFF state when the document is opened. + + A enumeration member that specifies whether the group is set to the state when the document is opened. + + + + Represents the optional content usage application. + + + + + Gets names, each of which corresponds to a usage dictionary entry. + + A collection of strings that represent names, each of which corresponds to a usage dictionary entry. + + + + Gets a name defining the situation in which this usage application should be used. + + A PdfOptionalContentUsageApplicationEvent enumeration value that defines the situation in which this usage application should be used. + + + + Gets optional content groups that will have their states automatically managed based on information in their usage. + + A collection of objects that represent optional content groups. + + + + Represents the list of options in the choice field, each of which shall be represented by a text string that shall be displayed on the screen. + + + + + Gets a text that represents the option’s export value. + + A object that represents the option’s export value. + + + + Gets the text representing one of the available options in the choice field. + + A object that represents one of the available options in the choice field. + + + + A rectangle that delimits a page area around a specific document element. + + + + + Initializes a new instance of the class with the specified location, size, and angle. + + A object that represents the top left corner of the rectangular region. + A value that specifies the width of the rectangular region. + A value that specifies the height of the rectangular region. + A value that specifies the rotation angle of the rectangle (in radians). A positive value indicates counterclockwise rotation; a negative value indicates clockwise rotation. + + + + Initializes a new instance of the class with the specified location and size. + + A object that represents the top left corner of the rectangular region. + A value that represents the width of the rectangular region. + A value that represents the height of the rectangular region. + + + + Gets the rotation angle of the rectangle. + + A value that is the rotation angle of the rectangle in radians. + + + + Provides access to the PdfOrientedRectangle object’ s minimum bounding rectangle. + + An PdfRectangle object that is the minimum bounding rectangle. + + + + Determines whether the current PdfOrientedRectangle object contains the specified rectangle. + + Specifies the rectangle to test. + true, if the specified rectangle belongs to the current PdfOrientedRectangle object; otherwise, false. + + + + Determines whether the current PdfOrientedRectangle object contains the specified point. + + Specifies the point to test. + true, if the specified point belongs to the current PdfOrientedRectangle object; otherwise, false. + + + + Gets the rectangle height. + + A value that is the rectangle height. + + + + Gets the rectangle position in relation to the left edge of the page. + + A value. + + + + Gets the rectangle position in relation to the top edge of the page. + + A value. + + + + Provides access to the PdfOrientedRectangle object’s vertices. + + A list of vertices (starting from top left). + + + + Gets the rectangle width. + + A value that is the rectangle width. + + + + Represents a document outline that allows the user to navigate interactively from one part of the document to another. + + + + + Provides access to the action that should be performed when the outline item is activated. + + A object that is an action that is performed with outlines. + + + + Gets the color of the outline entry’s text in the navigation pane. + + A object that represents the color for an outline entry’s text. + + + + Gets a destination (a particular view of a document), which is displayed when an outline item is activated. + + A object that is an outline destination. + + + + Gets a value indicating whether the outline’s text is formatted as bold. + + true, if the outline’s text is bold; otherwise, false. + + + + Gets the value indicating whether the outline’s text is formatted as italic. + + true, if the outline’s text is italic; otherwise, false. + + + + Gets the next item at the outline level. + + A object that is the next outline item. + + + + Gets the parent of the outline item in the outline hierarchy. + + A object that represents the parent of the outline item. + + + + Gets the previous item at the outline level. + + A object that is the previous outline item. + + + + Gets the text that is displayed for the outline item. + + A string that is displayed on the screen for the outline item. + + + + Represents an outline item in the tree-structured hierarchy of outlines. + + + + + Gets or sets a value that indicates whether the outline item is closed when it is displayed on the screen. + + true, if the outline item is hidden (closed); otherwise, false. + + + + Gets the total number of visible outline items at all levels of the outline. + + An integer value that is the outline items count. + + + + Gets the first top-level item in the outline. + + A object that is the first top-level item in the outline. + + + + Gets the last top-level item in the outline. + + A object that is the last top-level item in the outline. + + + + Represents the root of a document’s outline hierarchy. + + + + + An individual page in a document. + + + + + Provides access to a dictionary of additional actions to be performed when the page is opened or closed. + + A DevExpress.Pdf.PdfPageActions object. + + + + Provides access to the collection of annotation dictionaries that contain indirect references to all annotations associated with the page. + + A collection of objects. + + + + Indicates the tab order that shall be used for annotations on the page. + + A DevExpress.Pdf.PdfAnnotationTabOrder enumeration value. + + + + Specifies the art box defining the boundaries of the meaningful content (including potential white space) on a page as intended by the page’s creator. + + A object, specifying the art box. + + + + Provides access to the collection of indirect references to all article beads appearing on the page. + + A collection of DevExpress.Pdf.PdfBead objects. + + + + Specifies the bleed box defining the region to which the contents of the page shall be clipped when output in a production environment. + + A object, specifying the bleed box. + + + + Gets the PDF page commands. + + A object that represents the page commands. + + + + Indicates the display duration of a page (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page. + + A value. + + + + Returns the page index. + + The page index. + + + + Indicates the digital identifier of the page’s parent Web Capture content set. + + A array. + + + + Specifies the date and time when the page’s contents were most recently modified. + + A nullable value. + + + + Provides access to a metadata stream that contains metadata for the page. + + A object. + + + + Offsets the page content. + + The horizontal offset (in points). + The vertical offset (in points). + + + + Provides access to a page-piece dictionary associated with the page. + + A dictionary, containing the DevExpress.Pdf.PdfPieceInfoEntry objects, along with their keys. + + + + Specifies the page’s preferred zoom factor, i.e. the factor by which it shall be scaled to achieve the natural display magnification. + + A nullable value. + + + + Resizes the page content. + + New page size. + The content’s horizontal alignment. + The content’s vertical alignment. + + + + Rotates the page content relative to the specified point. Document annotations are not rotated. + + The point’s X coordinate in the page coordinate system. + The point’s Y coordinate in the page coordinate system. + The degree of rotation (from 0 to 360). + + + + Scales the page content. + + The horizontal scale factor (1 is 100%). + The vertical scale factor (1 is 100%). + + + + Indicates the key of the page’s entry in the structural parent tree. + + A nullable integer value. + + + + Provides access to a stream object that defines the page’s thumbnail image. + + A DevExpress.Pdf.PdfImage object. + + + + Provides access to a transition dictionary describing the transition effect that shall be used when displaying the page during presentations. + + A DevExpress.Pdf.PdfPagePresentation object. + + + + Specifies the group attributes dictionary that specifies the attributes of the page’s page group for use in the transparent imaging model. + + A DevExpress.Pdf.PdfTransparencyGroup object. + + + + Specifies the trim box defining the intended dimensions of the finished page after trimming. + + A object, specifying the trim box. + + + + Indicates the size of default user space units, in multiples of 1⁄72 inch. + + A value. The default value is 1.0 (user space unit is 1⁄72 inch). + + + + Exposes members used to perform various operations on a PDF page without access to its inner structure. + + + + + Creates a caret annotation in the specified page rectangle. + + A page area to add the caret annotation. + An object that contains caret annotation properties. + + + + Creates a circle annotation in the specified page rectangle. + + The page area to create the circle annotation. + An object that contains circle annotation properties. + + + + Creates a file attachment annotation at the specified point on the page. + + The point on the page to position the annotation. + The file associated with this annotation. + The name of the annotation icon. Use the PdfFileAttachmentAnnotationIconName class fields to specify a built-in icon. + An object that contains file attachment annotation properties. + + + + Creates a file attachment annotation at the specified point on the page. + + The point on the page to position the annotation. + The file associated with this annotation. + An object that contains file attachment annotation properties. + + + + Creates a file attachment annotation in the specified page rectangle. + + A page area to add the annotation. + The file associated with this annotation. + The annotation icon name. + An object that contains file attachment annotation properties. + + + + Adds a file attachment annotation in the specified page rectangle. + + A page area to add the annotation. + The file associated with this annotation. + An object that contains file attachment annotation properties. + + + + Creates a free text annotation in the specified page rectangle. + + A page area to add the annotation. + An annotation text. + An object that contains free text annotation properties. + + + + Creates an ink annotation comprised of one or multiple points on the page. + + A list of points used create an annotation. + An object that contains ink annotation properties. + + + + Creates a line annotation between the specified points. + + The start point of the annotation. + The end point of the annotation. + An object that contains the line annotation properties. + + + + Creates a link annotation in the specified page rectangle. + + A page area to add a link annotation. + A destination (a page reference with specific view parameters) to which the annotation refers. + An object that contains link annotation properties. + + + + Creates a link annotation in the specified rectangle on the page. + + A page area to add a link annotation. + A URI associated with the annotation. + An object that contains link annotation properties. + + + + Creates a polygon annotation by the specified vertices. + + An array of points that is the polygon vertices. + An object that contains polygon annotation properties. + + + + Creates a polyline annotation by the specified vertices. + + An array of polyline vertices. + An object that contains polyline annotation properties. + + + + Creates a rubber stamp annotation at the specified page point. + + A point on the page to position the rubber stamp annotation. + The name of the annotation icon. Use the PdfRubberStampAnnotationIconName fields to specify a built-in annotation icon. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. + + A page area to add the rubber stamp annotation. + A stream that contains a document used to generate a stamp. + The number of the document page used to generate a stamp. + true to make the stamp aspect ratio fit the specified rectangle; otherwise, false. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. + + A page area to add the rubber stamp annotation. + A stream that contains a document used to generate a stamp. + The number of the document page used to generate a stamp. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. + + A page area to add the rubber stamp annotation. + The name of the annotation icon. Use the PdfRubberStampAnnotationIconName fields to specify a built-in annotation icon. + true to make the stamp aspect ratio fit the specified rectangle; otherwise, false. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. Allows you use another document to generate a stamp. + + The page area where to add the rubber stamp annotation. + The name of the document file used to generate a stamp (including the full path). + The number of the document page used to generate a stamp. + true to make the stamp aspect ratio fit the specified rectangle; otherwise, false. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. + + A page area to add the rubber stamp annotation. + The name of the document file used to generate a stamp (including the full path). + The number of the document page used to generate a stamp. + An object that contains rubber stamp annotation properties. + + + + Creates a rubber stamp annotation in the specified page rectangle. + + A page area to add the rubber stamp annotation. + The name of the annotation icon. Use the PdfRubberStampAnnotationIconName fields to specify a built-in annotation icon. + An object that contains rubber stamp annotation properties. + + + + Creates a square annotation in the specified page rectangle. + + The page area to create the square annotation. + An object that contains square annotation properties. + + + + Adds a text annotation at the specified point on the page. + + The point on the page to position the text annotation. + The name of the annotation icon. + An object that contains text annotation properties. + + + + Adds a text annotation at the specified point on the page. + + The point on the page to position the text annotation. + An object that contains text annotation properties. + + + + Adds a text annotation to the specified area on the page. + + A page area to add the text annotation. + The name of the annotation icon. + An object that contain text annotation properties. + + + + Adds a text annotation to the specified area on the page. + + A page area to add the text annotation. + An object that contains text annotation properties. + + + + Creates a text markup annotation at the specified page area. + + A rectangle that specifies a page area where the annotation should be located. + The text markup annotation type. + An object that contain text markup annotation properties. + + + + Creates a text markup annotation for the text located in the specified page rectangle. + + The rectangle with the text that should be annotated. + The text markup annotation type. + An object that contain text markup annotation properties. + + + + Creates a text markup annotation at the specified page area. + + A collection of rectangles that specify a page area where the annotation should be located.’ + The text markup annotation type. + An object that contain text markup annotation properties. + + + + Creates a text markup annotation at the specified page area. + + A collection of quadrilaterals used to specify the text markup annotation bounds. + The text markup annotation type. + An object that contain text markup annotation properties. + + + + Returns all page annotation properties. + + A list of objects that contain annotation properties. + + + + Clears the document content located in the specified regions. Allows you to set what content type to keep in these regions. + + Page regions to clear. + Options that specify what content type to keep in target regions. + + + + Clears the document content located in the specified regions. + + Page regions to clear. + + + + Clears the document content located in the specified rectangle. Allows you to specify what content type to keep. + + A page rectangle to clear. + Options that specify what content type to keep in the target rectangle. + + + + Clears the document content located in the specified rectangle. Allows you to set whether to use the page coordinate system, and what content type to keep. + + A page rectangle to clear. + true to use the page coordinate system; otherwise, false. + Options that specify what content type to keep in the target rectangle. + + + + Clears the document content located in the specified rectangle. Allows you to specify whether to use the page coordinate system. + + A page rectangle to clear. + true to use the page coordinate system; otherwise, false. + + + + Clears the document content located in the specified rectangle. + + A page rectangle to clear. + + + + Clears the document content located in the specified rectangle. Allows you to specify what content type to keep. + + A page rectangle to clear. + Options that specify what content type to keep in the target rectangle. + + + + Clears the document content located in the specified rectangle. Allows you to specify whether to use the page coordinate system, and what content type to keep. + + A page rectangle to clear. + true to use the page coordinate system; otherwise, false. + An object that contains clear content options. + + + + Clears the document content located in the specified rectangle. Allows you to specify whether to use the page coordinate system. + + A page rectangle to clear. + true to use the page coordinate system; otherwise, false. + + + + Clears the document content in the specified rectangle. + + A page rectangle to clear. + + + + Creates a FitB destination. + + The FitB destination. + + + + Creates a FitBH destination. The coordinate of the document window’s top left corner is retained from the previous view. + + The FitBH destination. + + + + Creates a FitBH destination. + + The Y coordinate that is positioned at the top left corner of the document window. Specify this coordinate in the user coordinate system. + The FitBH destination. + + + + Creates a FitBV destination. The coordinate positioned window’s top left corner is retained from the previous view. + + The FitBV destination on the page. + + + + Creates a FitBV destination. + + The X coordinate that is positioned at the top left corner of the document window. Specify this coordinate in the user coordinate system. + The FitBV destination. + + + + Creates a Fit destination. + + The Fit destination. + + + + Creates a FitH destination. The coordinate of the document window’s top left corner is retained from the previous view. + + The FitH destination. + + + + Creates a FitH destination. + + The Y coordinate that is positioned at the top left corner of the document window. Specify this coordinate in the user coordinate system. + The FitH destination on the page. + + + + Creates a FitR destination. + + The rectangle that is fit into the document viewer window. Specify this rectangle in the user coordinate system. + The FitR destination. + + + + Creates a FitV destination. The coordinate of the document window’s top left corner is retained from the previous view. + + The destination on the page. + + + + Creates a FitV destination. + + The X coordinate that is positioned at the left corner of the document window. Specify this coordinate in the user coordinate system. + The FitV destination. + + + + Creates an XYZ destination. The coordinate of the document window’s top left corner and the zoom factor is retained from the previous view. + + The XYZ destination. + + + + Creates an XYZ destination. + + The X page coordinate in user coordinate system. + The Y page coordinate in user coordinate system. + The zoom factor. + The XYZ destination. + + + + Creates an XYZ destination. The zoom factor is retained from the previous view. + + The X page coordinate in user coordinate system. + The Y page coordinate in user coordinate system. + The XYZ destination. + + + + Creates an XYZ destination. The page coordinate of the document window’s top left corner is retained from the previous view. + + The zoom factor. + The XYZ destination. + + + + Flattens all page annotations. + + + + + Flattens all page annotations with the specified types. + + An array of annotation types. + + + + Flattens all page annotations that meet the specified criteria. + + Defines a set of criteria for the object. + + + + Flattens page annotations with the specified names. + + An array of annotation names. + + + + Returns the page number. + + The page number. + + + + Retrieves the page’s rotation angle. + + The degree of rotation (from 0 to 360). + + + + Contains information about a page of a document opened in PDF Viewer. + + + + + Initializes a new instance of the class with specified settings. + + The page’s crop box in the user coordinate system. + The page rotation angle (in degrees). + + + + Gets the page’s crop box – the region to which the contents of the page shall be clipped (cropped) when displayed or printed. + + The page’s crop box in the user coordinate system. + + + + Obtains a page’s rotation angle. + + The page rotation angle (in degrees). + + + + Lists the values that define how the page is positioned in the PDF Viewer. + + + + + The PDF Viewer displays pages in one column. + + + + + The PDF Viewer displays one page at a time. + + + + + The PDF Viewer displays the pages in two columns, with odd-numbered pages on the left. + + + + + The PDF Viewer displays pages in two columns, with odd-numbered pages on the right. + + + + + The PDF Viewer displays the pages two at a time, with odd-numbered pages on the left. + + + + + The PDF Viewer displays the pages two at a time, with odd-numbered pages on the right. + + + + + Lists values that specify how to display the opened document. + + + + + When a document is opened in the viewer, it shows pages in full screen mode (no menu bar, window controls, or any other window is visible). + + + + + When a document is opened in the viewer, it shows pages and opens the Attachments panel to display attachments. + + + + + When a document is opened in the viewer, it shows only pages (Bookmarks, Attachments, Page Thumbnails, and Layers panels are hidden). + + + + + When a document is opened, for example, in the Adobe Acrobat Reader, the Reader shows pages and opens the optional content group panel (the Layers panel). + + + + + When a document is opened in the viewer, it shows pages and opens the Bookmarks panel to display outlines (bookmarks). + + + + + When a document is opened in the viewer, it shows pages and opens the Page Thumbnails panel to display thumbnails. + + + + + Provides settings that define page boundaries for specific content types. + + + + + Specifies the crop box imposing the page boundaries displayed in a PDF Viewer. + + A object, specifying the crop box. + + + + Specifies the media box defining the boundaries of the physical medium on which the page is to be printed. + + A object, specifying the media box. + + + + Rotates the document page at the specified angle. + + An integer value, specifying the page rotation angle (in degrees). + + + + Contains the standard paper sizes. + + + + + The PDF paper size for the A2 paper type is 420 x 594 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A3 paper type is 297 x 420 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A3 Extra paper type is 322 x 445 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A3 Extra Transverse paper type is 322 x 445 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A3 Rotated paper type is 420 x 297 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A3 Transverse paper type is 297 x 420 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 paper type is 210 x 297 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 Extra paper type is 235 x 322 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 Plus paper type is 210 x 330 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 Rotated paper type is 297 x 210 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 Small paper type is 210 x 297 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A4 Transverse paper type is 210 x 297 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A5 paper type is 148 x 210 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A5 Extra paper type is 174 x 235 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A5 Rotated paper type is 210 x 148 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A5 Transverse paper type is 148 x 210 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A6 paper type is 105 x 148 (millimeters). + + A page rectangle. + + + + The PDF paper size for the A6 Rotated paper type is 148 x 105 (millimeters). + + A page rectangle. + + + + The PDF paper size for the APlus paper type is 227 x 356 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B4 paper type is 250 x 353 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B4 Envelope paper type is 250 x 353 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B4 (JIS) Rotated paper type is 364 x 257 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B5 paper type is 176 x 250 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B5 Envelope paper type is 176 x 250 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B5 Extra paper type is 201 x 276 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B5 (JIS) Rotated paper type is 257 x 182 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B5 Transverse paper type is 182 x 257 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B6 Envelope paper type is 176 x 125 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B6 (JIS) paper type is 128 x 182 (millimeters). + + A page rectangle. + + + + The PDF paper size for the B6 (JIS) Rotated paper type is 182 x 128 (millimeters). + + A page rectangle. + + + + The PDF paper size for the BPlus paper type is 305 x 487 (millimeters). + + A page rectangle. + + + + The PDF paper size for the C3 Envelope paper type is 324 x 458 (millimeters). + + A page rectangle. + + + + The PDF paper size for the C4 Envelope paper type is 229 x 324 mm (millimeters). + + A page rectangle. + + + + The PDF paper size for the C5 Envelope paper type is 162 x 229 (millimeters). + + A page rectangle. + + + + The PDF paper size for the C65 paper type is 114 x 229 (millimeters). + + A page rectangle. + + + + The PDF paper size for the C6 Envelope paper type is 114 x 162 (millimeters). + + A page rectangle. + + + + The PDF paper size for the C paper type is 17 x 22 (inches). + + A page rectangle. + + + + The PDF paper size for the DL Envelope is 110 x 220 (millimeters). + + A page rectangle. + + + + The PDF paper size for the D paper type is 22 x 34 (inches). + + A page rectangle. + + + + The PDF paper size for the E paper type is 34 x 44 (inches). + + A page rectangle. + + + + The PDF paper size for the Executive paper type is 7.25 x 10.5 (inches). + + A page rectangle. + + + + The PDF paper size for the Folio paper type is 8.5 x 13 (inches). + + A page rectangle. + + + + The PDF paper size for the German legal fanfold paper type is 8.5 x 13 (inches). + + A page rectangle. + + + + The PDF paper size for the German standard fanfold paper type is 8.5 x 12 (inches). + + A page rectangle. + + + + The PDF paper size for the Invitation envelope paper type is 220 x 220 (millimeters). + + A page rectangle. + + + + The PDF paper size for the ISO B4 paper type is 250 x 353 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Italy envelope paper type is 110 x 230 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Japanese double postcard paper type is 200 x 148 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Japanese double postcard rotated paper type is 148 x 200 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Japanese postcard paper type is 100 x 148 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Japanese postcard rotated paper type is 148 x 100 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Ledger paper type is 17 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Legal paper type is 8.5 x 14 (inches). + + A page rectangle. + + + + The PDF paper size for the Legal Extra paper type is 9.275 x 15 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter paper type is 8.5 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter Extra paper type is 9.275 x 12 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter extra transverse paper type is 9.275 x 12 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter plus paper type is 8.5 x 12.69 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter rotated paper type is 11 x 8.5 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter small paper type is 8.5 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Letter transverse paper type is 8.275 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Monarch envelope paper type is 3.875 x 7.5 (inches). + + A page rectangle. + + + + The PDF paper size for the Note paper type is 8.5 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Number 10 envelope paper type is 4.125 x 9.5 (inches). + + A page rectangle. + + + + The PDF paper size for the Number 11 envelope paper type is 4.5 x 10.375 (inches). + + A page rectangle. + + + + The PDF paper size for the Number 12 envelope paper type is 4.75 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Number 9 envelope paper type is 3.875 x 8.875 (inches). + + A page rectangle. + + + + The PDF paper size for the Personal envelope paper type is 3.625 x 6.5 (inches). + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 16K paper type is 146 x 215 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 16K rotated paper type is 146 x 215 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 32K paper type is 97 x 151 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 32K big paper type is 97 x 151 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 32K big rotated paper type is 97 x 151 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China 32K rotated paper type is 97 x 151 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 1 envelope paper type is 102 x 165 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 10 envelope paper type is 324 x 458 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 10 rotated envelope paper type is 458 x 324 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 1 rotated envelope paper type is 165 x 102 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 2 envelope paper type is 102 x 176 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 2 rotated envelope paper type is 176 x 102 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 3 envelope paper type is 125 x 176 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 3 rotated envelope paper type is 176 x 125 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 4 envelope paper type is 110 x 208 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 4 rotated envelope paper type is 208 x 110 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 5 envelope paper type is 110 x 220 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China Envelope number 5 rotated envelope paper type is 220 x 110 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 6 envelope paper type is 120 x 230 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 6 rotated envelope paper type is 230 x 120 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 7 envelope paper type is 160 x 230 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 7 rotated envelope paper type is 230 x 160 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 8 envelope paper type is 120 x 309 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 8 rotated envelope paper type is 309 x 120 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 9 envelope paper type is 229 x 324 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the People’s Republic of China number 9 rotated envelope paper type is 324 x 229 (millimeters). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the Quarto paper type is 215 x 275 (millimeters). + + A page rectangle. + + + + The PDF paper size for the Standard paper type is 10 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Standard paper type is 10 x 14 (inches). + + A page rectangle. + + + + The PDF paper size for the Standard paper type is 11 x 17 (inches). + + A page rectangle. + + + + The PDF paper size for the Standard paper type is 12 x 11 (inches). Requires Windows 98, Windows NT 4.0, or later. + + A page rectangle. + + + + The PDF paper size for the Standard paper type is 15 x 11 (inches). + + A page rectangle. + + + + The PDF paper size for the Statement paper type is 5.5 x 8.5 (inches). + + A page rectangle. + + + + The PDF paper size for the Tabloid paper type is 11 x 17 (inches). + + A page rectangle. + + + + The PDF paper size for the Tabloid extra paper type is 11.69 x 18 (inches). + + A page rectangle. + + + + The PDF paper size for the US standard fanfold is 14.875 x 11 (inches). + + A page rectangle. + + + + Provides the security password to open a protected PDF file in the PDF Viewer and PDF Document Processor. + + + + + Returns the file name of a document that is requested to be opened in the PDF Viewer or PDF Document Processor. + + A value, specifying the file name. + + + + Returns the path of the file requested to be opened in the PDF Viewer or PDF Document Processor. + + The file path. + + + + This property is now obsolete. Use the PdfPasswordRequestedEventArgs.PasswordString property instead. + + A value. + + + + Returns the current number of password request attempts. + + An integer value that is the current number of password requests. + + + + Specifies the security password to open a PDF file. + + The security password. + + + + This event handler is used to programmatically provide a document opening password in a PDF Viewer and PDF Document Processor to open a document without end-user interaction. + + The event sender. + A object that is used to provide the security password to open a protected PDF file in the PDF Viewer and PDF Document Processor. + + + + Contains a set of properties used to manage path (line, polygon and polyline) annotations without access to their inner structure. + + + + + Gets or sets the border style of the path annotation. + + Indicates the annotation border style. + + + + Gets or sets the width of the path annotation border. + + The annotation border width. + + + + Gets or sets the interior color used to fill the annotation’s line endings. + + The annotation’s interior color. + + + + Returns a list of annotation vertices. + + A list of vertices. + + + + Represents a color pattern. + + + + + Gets a pattern matrix that specifies the transformation from pattern space to user space. + + A PdfTransformationMatrix object that represents the pattern matrix. + + + + Contains information about the PKCS#7 signature and methods used to verify it. + + + + + Gets the PKCS#7 signature certificate. + + The X.509 certificate. + + + + Gets the certificate chain of the PKCS#7 signature. + + A collection of X.509 certificates. + + + + Gets the date and time of the signature (the timestamp). + + The date and time of the signature (the timestamp). + + + + Verifies the PKCS#7 signature. + + true if the signature is valid; otherwise, false. + + + + Validates the timestamp of the PKCS#7 signature. + + true if the timestamp is valid; otherwise, false. + + + + Specifies the coordinates of a PDF point. + + + + + Initializes a new instance of the class with the specified coordinates. + + A value. This value is assigned to the PdfPoint.X property. + A value. This value is assigned to the PdfPoint.Y property. + + + + Determines whether the specified object is equal to the current PdfPoint object. + + A PdfPoint to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether the specified object is equal to the current PdfPoint object. + + A point to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Returns a number that identifies the object instance. + + The hash code for the current object. + + + + Adds a PdfPoint object to the PdfPoint object and returns the result as the PdfPoint object. + + A PdfPoint object to add. + A PdfPoint object to add. + The sum of two PdfPoint objects. + + + + Divides two values. + + A value that is the dividend. + A value that is the divisor. + A value that is the result of division. + + + + Divides a PdfPoint value to the value. + + A PdfPoint value that is the dividend. + A value that is the divisor. + A object that is the result of dividing. + + + + Compares two structures for equality. + + The first instance to compare. + The second instance to compare. + true, if two objects are equal; otherwise, false. + + + + Compares two structures to determine whether they are not equal. + + The first instance to compare. + The second instance to compare. + true, if two objects are not equal; otherwise, false. + + + + Multiplies two values. + + A PdfPoint value to multiply. + A PdfPoint value to multiply. + The result of multiplication. + + + + Multiplies the PdfPoint value by the value. + + A PdfPoint value to multiply. + A value to multiply. + The result of multiplication. + + + + Multiplies the value by the PdfPoint value. + + A value to multiply. + A PdfPoint value to multiply. + The result of multiplication. + + + + Subtracts the value from the value. + + The minuend. + The subtrahend. + The result of subtraction. + + + + Negates the value of the specified operand. + + The value to negate. + The result of the value multiplied by negative one (-1). + + + + Gets the X coordinate of the . + + A value that is the PDF point’s X coordinate. + + + + Gets the Y coordinate of the . + + A value that is the PDF point’s Y coordinate. + + + + Contains members used to manage polygon annotations without access to their inner structure. + + + + + Gets or sets the intensity of the border effect. + + Border effect intensity (from 0 to 2). + + + + Gets or sets the effect applied to the annotation border. + + Indicates the border effect. + + + + Contains members used to manage polyline annotations without access to their inner structure. + + + + + Gets or sets the style of the line’s end point. + + Indicates the line start style. + + + + Gets or sets the style of the line’s start point. + + Indicates the line start style. + + + + Represents a pop-up annotation that displays text in a pop-up window for editing the annotation text. + + + + + Gets the value that indicates whether the popup annotation is opened on the page. + + true if the popup annotation is opened on the page; otherwise false. + + + + Gets the parent of the popup annotation item in the annotation hierarchy. + + A object that represents the popup annotation parent. + + + + Lists values that specify the document print mode. + + + + + Double-sided print that flips pages on the long edge. + + + + + Double-sided print that flips pages on the short edge. + + + + + No print mode is specified. + + + + + Single-sided print. + + + + + A range of pages to print. + + + + + Initializes a new instance of the class with specified settings. + + The number of the first page in the range. + The number of the last page in the range. + + + + The number of the last page in the print range. + + The page number. + + + + The number of the first page in the print range. + + The page number. + + + + Lists values that specify the scaling mode for printed documents. + + + + + The scaling is defined by the application. + + + + + No scaling is specified. + + + + + Represents a quadrilateral that comprises the annotation. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the coordinates of the first quadrilateral point. + A object that represents the coordinates of the second quadrilateral point. + A object that represents the coordinates of the third quadrilateral point. + A object that represents the coordinates of the fourth quadrilateral point. + + + + Gets the first quadrilateral point in the default user space. + + A object that is the first quadrilateral point in the default user space. + + + + Gets the second quadrilateral point in the default user space. + + A object that represents the second quadrilateral point in the default user space. + + + + Gets the third quadrilateral point in the default user space. + + A object that is the third quadrilateral point in the default user space. + + + + Gets the fourth quadrilateral point in the default user space. + + A object that is the fourth quadrilateral point in the default user space. + + + + Contains properties used to change the radio button field’s widget annotation without access to its inner structure. + + + + + Gets or sets whether a radio button is checked. + + true if the radio button is checked; otherwise, false. Default value is false. + + + + Contains a set of properties used to manage radio group form fields without access to their inner structure. + + + + + Gets form field items. + + A list of form field items. + + + + Gets or sets whether to turn radio group buttons on and off in unison. + + true to turn radio buttons on and off in unison; otherwise, false. + + + + Gets or sets whether only one radio button can be selected. + + true to select select only one radio button and if the user selects the selected button again, it has no effect; false to deselect the button if it is selected again. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Gets or sets the form field value—the name of the radio group item. + + The name of the radio group item. + + + + Represents a range of colors. + + + + + Initializes a new instance of the class with the specified settings. + + A value. This value is assigned to the PdfRange.Min property. + A value. This value is assigned to the PdfRange.Max property. + + + + Gets the upper value to which the corresponding sample value in the image is mapped. + + A value that is the upper value to which the corresponding sample value in the image is mapped. + + + + Gets the lower value to which the corresponding sample value in the image is mapped. + + A value that is the lower value to which the corresponding sample value in the image is mapped. + + + + A rectangle used to describe locations on a page and bounding boxes for various PDF objects. + + + + + Initializes a new instance of the class with the specified settings. + + Specifies the lower left x-coordinate. + Specifies the lower left y-coordinate. + Specifies the upper right x-coordinate. + Specifies the upper right y-coordinate. + + + + Gets the ‘s bottom coordinate. + + A value, representing the bottom coordinate of the PDF rectangle. + + + + Gets the ‘s bottom left coordinate. + + A structure, representing the bottom left coordinate of the PDF rectangle. + + + + Gets the ‘s bottom right coordinate. + + A structure, representing the bottom right coordinate of the PDF rectangle. + + + + Gets the rectangle’s center coordinate. + + The center coordinate. + + + + Determines whether a point is inside the current rectangle. + + A structure that represents the point in a two-dimensional coordinate space. + true if a point is inside the current rectangle; otherwise false. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + Gets the ‘s height. + + A value that is the height of the PDF rectangle, in points (1/72 of an inch). + + + + Gets the ‘s left coordinate. + + A value, representing the left coordinate of the PDF rectangle. + + + + Gets the ‘s right coordinate. + + A value, representing the right coordinate of the PDF rectangle. + + + + Gets the ‘s top coordinate. + + A value, representing the top coordinate of the PDF rectangle. + + + + Gets the ‘s top left coordinate. + + A structure, representing the top left coordinate of the PDF rectangle. + + + + Gets the ‘s top right coordinate. + + A structure, representing the top right coordinate of the PDF rectangle. + + + + Gets the ‘s width. + + A value that is the width of the PDF rectangle, in points (1/72 of an inch). + + + + An action that jumps to a destination in another PDF file instead of the current file. + + + + + Gets the file in which the destination will be located. + + A object that represents the file in which the destination will be located. + + + + Gets a value that indicates whether to open the destination document in a new window. + + true to open the destination document in a new window; otherwise false. + + + + Lists rendering intents that determine how a color management system handles color conversion from one color space to another. + + + + + Colors shall be represented solely with respect to the light source; no correction shall be made for the output medium’s white point (such as the color of unprinted paper). + + + + + Colors shall be represented in a manner that provides a pleasing perceptual appearance. + + + + + Colors shall be represented with respect to the combination of the light source and the output medium’s white point (such as the color of unprinted paper). + + + + + Colors shall be represented in a manner that preserves or emphasizes saturation. + + + + + Provides PDF rendering settings to optimize JPEG image decoding. + + + + + For internal use. + + + + + + Specifies whether the external Windows Imaging Component (WIC) decoder can be used to optimize JPEG image decoding. + + true, to allow a use of the external DCT decoder to optimize JPEG image decoding; false, the GDI+ decoder is used for JPEG image decoding. The default value is true. + + + + An action that resets selected interactive form fields to their default values. + + + + + Gets a value that indicates whether to exclude fields obtained in the PdfResetFormAction.Fields property from resetting. + + if true all fields in the document’s interactive form will be reset except those listed in the PdfResetFormAction.Fields property; otherwise false. + + + + Gets a collection of fields that indicate which fields to reset or which to exclude from resetting, depending on the value of the PdfResetFormAction.ExcludeFields property. + + A collection of the objects that represent fields. + + + + Represents the red, green, and blue color components in the range of 0 to 1. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified red, green, and blue color components. + + A value. This value is assigned to the PdfRGBColor.R property. This value must be between 0 and 1. + A value. This value is assigned to the PdfRGBColor.G property. This value must be between 0 and 1. + A value. This value is assigned to the PdfRGBColor.B property. This value must be between 0 and 1. + + + + Gets or sets the blue color component value. + + A double value that is the blue color component value in the range of 0 to 1. + + + + Determines whether the specified object is equal to the current PdfRGBColor object. + + An object to compare with the current PdfRgbColor object. + true if the specified object is equal to the current object; otherwise, false. + + + + Gets or sets the green color component value. + + A double value that is the green color component value in a range of 0 to 1. + + + + Returns a number that identifies the object instance. + + An integer that identifies the color instance. + + + + Occurs every time any of the class properties has changed its value. + + + + + Gets or sets the red color component value. + + A double value that is the red color component value in a range of 0 to 1. + + + + Contains members used to manage rubber stamp annotations without access to their inner structure. + + + + + Gets or sets the name of the annotation icon. + + The annotation icon name. Use the PdfRubberStampAnnotationIconName fields to specify a built-in annotation icon. + + + + Gets or sets whether to make the stamp aspect ratio fit its rectangle. + + true to keep aspect ratio; otherwise, false. + + + + Gets or sets the annotation’s rotation angle. The annotation is rotated counterclockwise. + + The degree of rotation (from 0 to 360). + + + + Creates a custom rubber stamp icon from a page in another document. + + A stream that contains a document used to generate a stamp. + The target page number. + + + + Creates a custom rubber stamp icon from a page in another document. + + A stream that contains a document used to generate a stamp. + + + + Creates a custom rubber stamp icon from a page in another document. + + The name of a document (including a full path) used to generate a stamp. + The target page number. + + + + Creates a custom rubber stamp icon from a page in another document. + + The name of a document (including full path) used to generate a stamp. + + + + Contains names of built-in rubber stamp annotation icons. + + + + + The Approved icon name. + + The icon name. + + + + The As Is icon name. + + The icon name. + + + + The Confidential icon name. + + The icon name. + + + + The Approved icon from the Dynamic Stamps category. + + The icon name. + + + + The Confidential icon from the Dynamic Stamps category. + + The icon name. + + + + The Departmental icon name. + + The icon name. + + + + The Draft icon name. + + The icon name. + + + + The Received icon from the Dynamic Stamps category. + + The icon name. + + + + The Reviewed icon from the Dynamic Stamps category. + + The icon name. + + + + The Revised icon from the Dynamic Stamps category. + + The icon name. + + + + The Experimental icon name. + + The icon name. + + + + The Expired icon name. + + The icon name. + + + + The Final icon name. + + The icon name. + + + + The For Comment icon name. + + The icon name. + + + + The For Public Release icon name. + + The icon name. + + + + The Not Approved icon name. + + The icon name. + + + + The Not for Public Release icon name. + + The icon name. + + + + The Accepted icon from the Sign Here category. + + The icon name. + + + + The Initial Here icon from the Sign Here category. + + The icon name. + + + + The Rejected icon from the Sign Here category. + + The icon name. + + + + The Sign Here icon from the Sign Here category. + + The icon name. + + + + The Witness icon from the Sign Here category. + + The icon name. + + + + The Sold icon name. + + The icon name. + + + + The Top Secret icon name. + + The icon name. + + + + A class that provides document encryption options and document signature to save the document. + + + + + Gets or sets whether to disable the xmp:CreateDate metadata node update. + + true to disable metadata node update; otherwise, false. + + + + Gets or sets whether to disable all mandatory metadata updates. + + true to disable mandatory metadata nodes update; otherwise, false. + + + + Gets or sets whether to disable the xmp:ModifyDate metadata node update. + + true to disable metadata node update; otherwise, false. + + + + Specifies encryption options of a PDF document. + + A object that represents encryption options of a PDF document. + + + + Gets or sets the signature, which can contain signing info, reason and location, to be used to save the signed document. + + A object that represents the PDF signature. + + + + Contains a set of properties used to manage shape (circle and square) annotations without access to their inner structure. + + + + + Gets or sets the intensity of the border effect. + + Border effect intensity (from 0 to 2). + + + + Gets or sets the effect applied to the annotation border. + + Indicates the border effect. + + + + Gets or sets the style of the annotation border. + + Indicates the annotation border style. + + + + Gets or sets the width of the annotation border. + + The annotation border width. + + + + Gets or sets the annotation’s fill color. + + The annotation fill color. + + + + An electronic signature used to sign a PDF file. + + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + An array of bytes containing an image. + An integer value that specifies the page number where the signature should be added. + The signature borders in the default user space and signature rotation angle (in radians). A positive angle means counterclockwise rotation; a negative angle means clockwise rotation. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + An array of bytes containing an image. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + A System.IO.Stream class descendant, specifying the stream with the image data. + An integer value that specifies the page number where the signature should be added. + The signature borders in the default user space and signature rotation angle (in radians). A positive angle means counterclockwise rotation; a negative angle means clockwise rotation. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + A System.IO.Stream class descendant, specifying the stream with the image data. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + + + + Initializes a new instance of the class with the specified certificate, image data represented by a byte array, page number, signature bounds and signature rotation angle represented by a object. + + A object that is an X.509 certificate. + An array of bytes containing an image. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space and signature rotation angle (in radians). A positive angle means counterclockwise rotation; a negative angle means clockwise rotation. + + + + Initializes a new instance of the class with the specified certificate, image data represented by a byte array, page number and the signature bounds represented by a object. + + A object that is an X.509 certificate. + An array of bytes containing an image. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space. + + + + Initializes a new instance of the class with the specified certificate, image data represented by a stream, page number, signature bounds and signature rotation angle represented by a object. + + A object that is an X.509 certificate. + A System.IO.Stream class descendant, specifying the stream with the image data. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space and signature rotation angle (in radians). A positive angle means counterclockwise rotation; a negative angle means clockwise rotation. + + + + Initializes a new instance of the class with the specified certificate, image data represented by a stream, page number and the signature bounds represented by a object. + + A object that is an X.509 certificate. + A System.IO.Stream class descendant, specifying the stream with the image data. + An integer value that specifies the page number where the signature should be added. + A object that represents the signature bounds in the default user space. + + + + Initializes a new instance of the class with the specified certificate. + + A object that is an X.509 certificate. + + + + Gets or sets the signature’s characteristics. + + A set of annotation flags. + + + + Specifies the contact information which helps a recipient to verify the signature provided by the signer. + + A object that is the contact information provided by the signer to a recipient. + + + + Gets or sets the signing location. + + A object that is the location associated with the identity. + + + + Gets or sets the name of the person or authority signing the document. + + A object that is the person or authority name signing the document. + + + + Gets or sets the reason for a document signature. + + A object that is the reason for a document signature. + + + + Gets the time the document was signed. + + A nullable structure that is the date and time the document was signed. + + + + Contains signature appearance options. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the type of a graphic displayed on the left side of the signature. + + Indicates the signature appearance type. + + + + Gets or sets the version of the application used to sign the document. + + The application version. + + + + Gets or sets the date and time format for the signing time. + + The date and time format. + + + + Gets or sets whether the text direction is right-to-left. + + true to enable right-to-left text direction; otherwise, the text direction is left-to-right. + + + + Sets the signature’s background image data. + + A byte array that stores image pixel data. + + + + Sets the signature’s background image data. + + A stream used to load image data. + + + + Sets the signature’s background image data. + + A path to the image file. + + + + Sets the signature’s image data. + + A byte array that stores image pixel data. + + + + Sets the signature’s image data. + + A stream used to load image data. + + + + Sets the signature’s image data. + + A path to the image file. + + + + Gets or sets whether to show the date (specified by the PdfSignatureBuilder.SigningTime property) in signature details. + + true to show the date; otherwise, false. + + + + Gets or sets whether to show the distinguished name (retrieved from the certificate) in signature details. + + true to show the distinguished name; otherwise, false. + + + + Gets or sets whether to show a label for each item in signature details. + + true to show labels; otherwise, false. + + + + Gets or sets whether to show the signing location (specified by the PdfSignatureInfo.Location property) in signature details. + + true to show the location; otherwise, false. + + + + Gets or sets whether to show the signer name (specified by the PdfSignatureBuilder.Name or in the certificate) in signature details. + + true to show the name; otherwise, false. + + + + Gets or sets whether to show the reason why the signature is applied (specified by the PdfSignatureBuilder.Reason property) in signature details. + + true to show the reason; otherwise, false. + + + + Gets or sets the font settings for the signature details. + + An object that contains font settings. + + + + Gets or sets the font settings for the signature name (appears on the left side of the signature). + + An object that contains font settings. + + + + Lists values that specify the type of graphic displayed on the left side of the signature. + + + + + An image is displayed on the left side of the signature. + + + + + A name is displayed on the left side of the signature. + + + + + No graphic is used on the left side of the signature. + + + + + Allows you to build a signature. + + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + An object that contains information about a signature field. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + The name of the signature form field to sign. + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a signature. + + + + Specifies the name of the software module used to create the signature. + + The software module name. + + + + Specifies the signature certification level. + + One of the enumeration values specifying the certification level. + + + + Gets or sets the signer’s contact information. + + A contact information. + + + + Gets or sets the signing location. + + The location associated with the signer’s identity. + + + + Gets or sets a signer’s name. + + A signer’s name. + + + + Gets or sets the reason to apply a signature. + + A reason for a signature (for example, “I Agree”). + + + + Sets the signature’s image data. + + A byte array that represents image data. + + + + Sets the signature’s image data. + + A stream used to load image data. + + + + Sets the signature’s image data. + + A path to the image file. + + + + Sets the signature appearance. + + An object that contains appearance settings. + + + + Specifies the date and time when the signature is applied. + + The date and time when the signature is applied. + + + + Contains information about the signature field. + + + + + Initializes a new instance of the class with specified settings. + + A list of page numbers to place the signature field. + + + + Initializes a new instance of the class with specified settings. + + A number of the page to place the signature field. + + + + Gets or sets the signature field’s annotation flags. + + One of the enumeration values indicating signature field’s parameters + + + + Gets or sets the signature field’s name. + + A field name. + + + + Gets or sets the signature field’s rotation angle. + + The degree of rotation. + + + + Gets or sets the signature field’s bounds on the page (measured in the page coordinate system). + + A rectangle that defines the signature’s location. + + + + Lists values that specify various document-level characteristics related to signature fields. + + + + + The document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents. + + + + + No signature is applied to the document. + + + + + The document contains at least one signature field. + + + + + Contains font settings for a signature. + + + + + Initializes a new instance of the class with specified settings. + + The font family name. + + + + Gets or sets whether to format text as bold. + + true to make text bold; otherwise, false. + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Gets or sets the font color. + + The font color. + + + + Gets or sets the font family name. + + The font family name. + + + + Gets or sets whether to italicize text. + + true to format text in italics; otherwise, false. + + + + Gets or sets the font size. + + The font size. + + + + Exposes a set of properties used to modify signature form fields without access to their inner structure. + + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Contains signature information. + + + + + Gets the signature’s certification level. + + An enumeration value that indicates the certification level. + + + + Gets the signer’s contact information. + + A contact information. + + + + Returns signature contents as a byte array (including zero padding at the end of the array). + + An array of signature value bytes or null (Nothing in Visual Basic) if the Contents entry is missing in the signature dictionary. + + + + Gets the name of a signature form field. + + The form field’s name. + + + + Retrieves the name of the preferred signature handler. + + Preferred signature handler’s name. + + + + Gets the place where the signature was applied (for example, the company address). + + The location associated with the signer’s identity. + + + + Gets the reason to apply a signature. + + A reason for a signature (for example, “I Agree”). + + + + Gets a signer’s name. + + A signer’s name. + + + + Gets the date and time when the signature is applied. + + The date and time when the signature is applied. + + + + Gets information about the signature’s format. + + The signature’s encoding and key information. + + + + Lists values used to specify the signature profile type. + + + + + PAdES (PDF Advanced Electronic Signature) baseline profile. + + + + + Standard PDF profile for PKCS#7 signatures. + + + + + Lists values used to specify the signature type. + + + + + A signature with a PAdES baseline profile. + + + + + A PKCS#7 signature. + + + + + A document-level timestamp. + + + + + Contains properties used to change the signature field’s widget annotation properties without access to its inner structure. + + + + + A sound associated with a sound annotation. + + + + + Initializes a new instance of the class. + + + + + Specifies the number of bits per sample value per channel. + + The number of bits per sample value. + + + + Gets or sets sound data. + + Sound data. + + + + Gets or sets the encoding format of the sample data. + + Indicates the encoding format. + + + + Gets or sets the sampling rate in samples per second. + + The sampling rate. + + + + Gets or sets the number of sound channels. + + The number of sound channels. The default is 1. + + + + A sound annotations – a note that contains a sound recorded or imported form a file. + + + + + Gets the type into which the annotation falls in the Type filter. + + An enumeration value that indicates the annotation type. + + + + Gets or sets the name of the sound annotation icon. + + The annotation icon name. + + + + Returns a sound attached to an annotation. + + A sound attached to the annotation. + + + + Contains members used to manage sound annotations without access to their inner structure. + + + + + Specifies the name of the annotation icon. + + The annotation icon name. Use the class fields to specify one of the built-in icons. + + + + Gets or sets sound data associated with the annotation. + + The sound associated with the annotation. + + + + Contains names of built-in sound annotation icons. + + + + + The Headphone icon name. + + The icon name. + + + + The Microphone icon name. + + The icon name. + + + + The Speaker icon name. + + The icon name. + + + + Lists the encoding formats of sample data associated with the sound annotation. + + + + + A-Law encoding. + + + + + m-Law encoding. + + + + + Unspecified or unsigned value (from 0 to 2B-1). + + + + + Twos-complement value. + + + + + Exposes members used to organize square annotations without access to their inner structure. + + + + + Specifies the alignment of a text string relative to its layout rectangle. + + + + + The text is aligned in the center of the layout rectangle. + + + + + The text is aligned far from the original position of the layout rectangle. + + + + + The text is aligned near the layout. + + + + + Contains settings to format strings in a document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified string format. + + A object. + + + + Initializes a new instance of the class with the specified string format flags. + + A enumeration value. + + + + Gets or sets the horizontal alignment of the string. + + A enumeration that specifies the horizontal alignment of the string. + + + + Creates a copy of this object. + + The object this method creates. + + + + Gets or sets a enumeration that contains format information. + + A enumeration that contains format information. + + + + Gets a generic default object. + + The generic default object. + + + + Gets a generic typographic object. + + A generic typographic object. + + + + Gets or sets the object for this object. + + The object. + + + + Gets or sets a value that is the fraction of the font em-size used as both horizontal and vertical leading string margins. + + A double value that is the fraction of the font em-size used as both horizontal and vertical leading string margins. + + + + Specifies the vertical alignment of the string. + + A enumeration that represents the vertical alignment of the string. + + + + Gets or sets a value that is the fraction of the font em-size used as the horizontal trailing string margin. + + A double value that is the fraction of the font em-size used as the horizontal trailing string margin. + + + + Gets or sets the enumeration for this object. + + A enumeration that indicates how text is trimmed when it exceeds the edges of the layout rectangle. + + + + Specifies the display and layout information for text strings. + + + + + Only entire lines are laid out in the formatting rectangle. + + + + + Includes the trailing space at the end of each line. + + + + + Overhanging parts of glyphs, and unwrapped text reaching outside the formatting rectangle are allowed to be displayed. + + + + + Text wrapping between lines when formatting within a rectangle is disabled. This flag is implied when a point is passed instead of a rectangle, or when the specified rectangle has a zero line length. + + + + + Specifies how to trim characters from a string that does not completely fit into a layout shape. + + + + + The text is trimmed to the nearest character. + + + + + The text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line. + + + + + The text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line. + + + + + Specifies no trimming. + + + + + The text is trimmed to the nearest word. + + + + + Represents a text annotation (a “sticky note” attached to a point in a document). + + + + + Gets the type into which the annotation falls in the Type filter. + + An enumeration value that indicates the annotation type. + + + + Gets the name of an icon that will be used in displaying the annotation. + + A value that is the name of a text annotation icon. + + + + Gets a value that indicates whether the annotation is opened on the page. + + true if the annotation is opened on the page; otherwise false. + + + + Gets the annotation state. + + A object that represents the annotation state. + + + + Gets a model corresponding to the specific annotation state. + + A string that represents the state model of the annotation. + + + + Represents a text annotation. + + + + + Specifies the name of the annotation icon. + + The icon name. + + + + Contains members used to manage text annotations (sticky notes) without access to their inner structure. + + + + + Gets or sets the name of the text annotation icon. + + The annotation icon name. Use the PdfTextAnnotationIconName fields to specify one of the built-in annotation icons. + + + + Contains names of built-in annotation icons. + + + + + Checkmark icon name. + + The icon name. + + + + Circle icon name. + + The icon name. + + + + “Comment” icon name. + + The icon name. + + + + Cross icon name. + + The icon name. + + + + Cross Hairs icon name. + + The icon name. + + + + Help icon name. + + The icon name. + + + + Insert Text icon name. + + The icon name. + + + + Key icon name. + + The icon name. + + + + New Paragraph icon name. + + The icon name. + + + + Text Note icon name. + + The icon name. + + + + Paragraph icon name. + + The icon name. + + + + Right Arrow icon name. + + The icon name. + + + + Right Pointer icon name. + + The icon name. + + + + Star icon name. + + The icon name. + + + + Up Arrow icon name. + + The icon name. + + + + Up-Left Arrow icon name. + + The icon name. + + + + Contains text extraction options. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to clip extracted content to the crop box. + + true, to clip content to the crop box; otherwise false. + + + + Lists values used to specify the text form field’s input format. + + + + + The field is divided into equally spaced positions or combs. The PdfTextFormField.MaxLen or PdfTextFormFieldFacade.MaxLength property defines the number of available characters. + + + + + The field value is a path to a file. + + + + + The field value is a password. + + + + + The field value is a plain text string. + + + + + The field value is a rich text string. + + + + + Represents a text field on a PDF form. + + + + + Gets the default text of the text form field. + + A object that represents the field’s default text. + + + + Specifies text form field’s input type. + + An enumeration value that indicates the input type. + + + + Gets the maximum length of the field’s text, in characters. + + A nullable integer value specifying the maximum length of the field’s text. + + + + Gets or sets whether the text field can contain multiple lines of text. + + true if the text box field can contain multiple lines of text; otherwise, false. + + + + Gets or sets whether to scroll the text field when the text does not fit its rectangle. + + true to allow scrolling; otherwise, false. + + + + Gets or sets whether to check spelling in the text form field. + + true to enable spell checking; otherwise, false. + + + + Gets the text form field’s text. + + A object that represents the field’s text. + + + + Retrieves the form field type. + + An enumeration value that indicates the form field type. + + + + Contains a set of properties used to manage text form fields without without access to their inner structure. + + + + + Specifies the text form field input type. + + An enumeration value that indicates the input type. + + + + Gets the maximum length of the field’s text, in characters. + + A nullable integer value that is the maximum length of the field’s text. + + + + Gets or sets whether the text field can contain multiple text lines. + + true if the text box field can contain multiple lines of text; otherwise, false. + + + + Gets or sets whether to scroll the text field when the text does not fit the widget rectangle. + + true to allow scrolling; otherwise, false. + + + + Gets or sets whether to check spelling in the text form field. + + true to enable spell check; otherwise, false. + + + + Gets or sets how the text is aligned in the form field. + + Indicates the text justification type. + + + + Gets the form field type. + + An enumeration value that indicates the form field type. + + + + Gets or sets the form field value. + + The text string that is the form field value. + + + + Lists the form of justification that is used in laying out the overlay text. + + + + + The centered form of justification is used in displaying the text. + + + + + The left justified form of justification is used in displaying the text. + + + + + The right justified form of justification is used in displaying the text. + + + + + Represents a text markup annotation. + + + + + Gets the type into which the annotation falls in the Type filter. + + An enumeration value that indicates the annotation type. + + + + Gets a collection of quadrilaterial points that encompass the areas of this annotation. + + An array of objects that represent the quadrilateral points. + + + + Gets the type of a text markup annotation. + + One of the enumeration values that represents the text markup annotation type. + + + + Represents a text markup annotation. + + + + + Specifies the text markup annotation type. + + One of the enumeration values that specifies the text markup annotation type. + + + + Gets a collection of quadrilaterals that encompass the text markup annotation’s drawing area. + + An array of objects that represent the quadrilaterals points. + + + + Contains members used to manage text markup annotations (text highlights) without access to their inner structure. + + + + + Gets or sets the text markup annotation type. + + Indicates the text markup annotation type. + + + + Specifies the type of a text markup annotation. + + + + + Highlight text markup annotation. + + + + + Squiggly underline text markup annotation. + + + + + Strikeout text markup annotation. + + + + + Underline text markup annotation. + + + + + Lists the available text search direction modes. + + + + + Specifies a backward search in the document. + + + + + Specifies a forward search in the document. + + + + + Specifies the options applied to a text search. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether or not to ignore the letter case when searching text in a PDF. + + true, to take into account the letter case; otherwise false. + + + + Specifies the direction of text search. + + A enumeration value, specifying the search direction. + + + + Specifies whether or not to take into account only whole words when searching text in a PDF. + + true, if whole words should match the search criteria; otherwise false. + + + + Provides the information related to a PDF text search result. + + + + + Provides access to the page containing the text found. + + A object. + + + + Indicates the zero-based index of a page that contains the found text. + + An integer value, specifying the zero-based page index. + + + + Indicates the number of a page that contains the text that was found. + + An integer value, specifying the page number. + + + + Provides access to the document area containing the text found. + + A collection of objects. + + + + Indicates the current text search operation status. + + A enumeration value. + + + + Returns the collection of words corresponding to the text that was found. + + A collection of objects. + + + + Lists the values specifying the status of a PDF text search operation. + + + + + The text search has finished. + + + + + The text, which is being searched for, has been found. + + + + + The text, which is being searched for, has not been found. + + + + + Contains properties used to change the text field’s widget annotation without access to its inner structure. + + + + + Allows you to generate document-level timestamps. + + + + + Initializes a new instance of the class with specified settings. + + An object used to generate a timestamp. + + + + Builds the signature and returns its contents. + + The document’s hash value. + The hash algorithm’s object identifier. + The signature contents. + + + + Builds the signature for the specified document. + + A stream that contains the document to sign. + The document-level timestamp signature. + + + + Retrieves the name of the preferred signature handler. + + Preferred signature handler’s name. + + + + Returns the signature size (in bytes). + + A signature’s size (in bytes). + + + + Returns information about a timestamp signature’s format. + + The signature’s encoding and key information. + + + + Returns the signature type. + + The signature type. + + + + Represents a URI (uniform resource identifier) action associated with the annotation. + + + + + Gets a value that determines whether to track the mouse position when the URI is resolved. + + true to track the mouse position when the URI is resolved; otherwise false. Default value: false. + + + + Returns the URI (uniform resource identifier) action that causes a URI to be resolved. + + A string that identifies a resource on the Internet. + + + + Lists values that specify the document area. + + + + + The art box (defines the boundaries of the meaningful content on a page as intended by the page creator). + + + + + The bleed box (includes extra bleed area that is required to accommodate the physical limitations of specific cutting, folding and trimming equipment). + + + + + The crop box (defines the region to which the contents of the page are clipped). + + + + + The media box (the boundaries of the physical medium). + + + + + The trim box (the intended dimensions of the finished page). + + + + + A bookmark in the PDF Viewer. + + + + + Gets whether the bookmark text is bold. + + true if the bookmark text is bold; otherwise, false. + + + + Returns the collection of bookmark children. + + The collection of bookmark children.’ + + + + Gets or sets whether the bookmark is initially expanded (bookmark children are displayed) in the navigation pane after a document is loaded. + + true if bookmark children are initially displayed; otherwise, false. + + + + Obtains the the color of a bookmark text. + + A bookmarks foreground color. + + + + Indicates whether the bookmark text is italicized. + + true if the bookmark text is italicized; otherwise, false. + + + + Occurs every time any of the PdfViewerBookmark class properties change their value. + + + + + Obtains the bookmark title. + + The bookmark title. + + + + Contains extension methods for bookmarks in the PDF Viewer. + + + + + Finds a bookmarks that meets the specified criteria. + + A list of bookmarks where to search. + An object that defines a set of criteria for the bookmark. + The target bookmark. + + + + Contains options that specify how to display a document on the screen. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to center the document window. + + true to center the document window; otherwise, false. + + + + Gets or sets the direction of the document content. + + Indicates the content direction. + + + + Gets or sets whether to display the document title in the window’s title bar. + + true to display the document title in the title bar; false to display the file name in the title bar. + + + + Gets or sets whether to resize the document window to fit the size of the first displayed page. + + true to fit the window to the document; otherwise, false. + + + + Gets or sets whether to hide the menu bar when the document is active. + + true to hide the menu bar; false to display the menu bar. + + + + Gets or sets whether to hide the toolbar when the document is active. + + true to hide the toolbar; false to display the toolbar. + + + + Gets or sets whether to hide User Interface elements (scroll bars and navigation controls) and display only document content. + + true to hide UI elements; otherwise, false + + + + Gets or sets how to display a document page in windowed mode (not full-screen mode). + + Indicates the page display mode. + + + + Gets or sets whether to use the PDF page size to select the input paper tray. + + true to select the check box associated with the input paper tray in the Print dialog; otherwise, false. + + + + Gets or sets the document’s print area. + + Indicates the print area. + + + + Gets or sets the clipped portion of the document content that is printed. + + Indicates the clipped area. + + + + Gets or sets the document’s print mode. + + Indicates the print mode. + + + + Gets or sets the number of document copies to print. + + The number of copies. + + + + Retrieves a list of pages to print. + + A list of page ranges. + + + + Gets or sets the scale mode for a printed document. + + Indicates the scale mode. + + + + Gets or sets the displayed document area. + + Indicates the displayed document area. + + + + Gets or sets the clipped portion of the document content that is displayed. + + Indicates the clipped document area. + + + + Represents the widget annotation for the interactive forms in a document. + + + + + Gets an action that will be performed when the widget annotation is active. + + A object that is the widget annotation action. + + + + Gets actions that will be performed when the annotation is activated. + + A object that represents actions that will be performed when the annotation is activated. + + + + Gets the appearance characteristics specifying the widget annotation’s visual presentation on the page. + + A object that represents the appearance characteristics of the widget annotation. + + + + Gets a value specifying the width and line style that shall be used in drawing the widget annotation’s border. + + A object that represents the widget annotation border style. + + + + Gets the widget annotation’s highlighting mode - the visual effect that shall be used when the mouse button is pressed or held down inside its active area. + + A enumeration value that represents the widget annotation’s highlighting mode. + + + + Gets an interactive form field that the widget annotation used to represent the appearance of fields and to manage user interactions. + + A object that is the interactive form field for the widget annotation. + + + + Lists values that specify the text position of the button widget annotation’s caption relative to its icon. + + + + + Caption above the icon. + + + + + Caption below the icon. + + + + + Caption overlaid directly on the icon. + + + + + Caption to the left of the icon. + + + + + Caption to the right of the icon + + + + + No caption, icon only. + + + + + No icon, caption only. + + + + + Contains appearance characteristics for constructing the annotation’s appearance. + + + + + Gets the widget annotation’s alternate (down) caption, which shall be displayed when the mouse button is pressed within its active area. + + A value that is the widget annotation’s alternate (down) caption. + + + + Gets the widget annotation’s alternate (down) icon, which will be displayed when the mouse button is pressed within its active area. + + A object that is a form XObject defining the widget annotation’s alternate (down) icon. + + + + Gets a value specifying the color of the widget annotation’s background. + + A object that is the color of the widget annotation’s background. + + + + Gets the value specifying the color of the widget annotation’s border. + + A object that is the color of the widget annotation’s border. + + + + Gets the widget annotation’s normal caption, which will be displayed when it is not interacting with the user. + + A value that is the widget annotation’s normal caption. + + + + Gets the value specifying how the widget annotation’s icon will be displayed within its annotation rectangle. + + A enumeration value that specifies how the widget annotation’s icon will be displayed within its annotation rectangle. + + + + Gets the widget annotation’s normal icon, which will be displayed when it is not interacting with the user. + + A object that is the widget annotation’s normal icon. + + + + Gets the widget annotation’s rollover caption, which will be displayed when the user rolls the cursor into its active area without pressing the mouse button. + + A object that is the widget annotation’s rollover caption. + + + + Gets the widget annotation’s rollover icon, which will be displayed when the user rolls the cursor into its active area without pressing the mouse button. + + A object that is the form XObject defining the widget annotation’s rollover icon. + + + + Gets the number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page. + + An integer value that is the widget annotation rotation angle. + + + + Gets the text position of the widget annotation’s caption relative to its icon. + + A enumeration value that is the text position of the widget annotation. + + + + Contains basic widget annotation properties. + + + + + Specifies the form field widget’s background color. + + The background color. + + + + Gets or sets the form field widget’s border color. + + The widget’s border color. + + + + Gets or sets the form field widget’s border style. + + An enumeration value that indicates the border style. + + + + Specifies the form field widget’s border width. + + The border width. + + + + Gets or sets the spacing between widget text characters + + The character spacing. A positive number specifies expanded character spacing, a negative value specifies condensed spacing. + + + + Gets or sets flags that specify various characteristics of the widget annotation. + + A set of annotation flags + + + + gets or sets whether to format widget text as bold. + + true, to make text bold; otherwise, false. + + + + Specifies the widget’s font or marker color. + + The font or marker color. + + + + Gets or sets whether to format widget text as italics. + + true, to italicize text; otherwise, false. + + + + Specifies the widget font name. + + The font name. + + + + Gets or sets the widget font size. + + The font size. + + + + Gets or sets the font’s scaling percentage. + + A double value (from 0 to 100) that is the font scaling percentage. + + + + Gets the the page number on which the widget is located. + + The page number. + + + + Gets or sets the widget’s bounds on the page. + + A rectangle that defines the widget’s location. + + + + Gets or sets the widget’s rotation angle. The widget is rotated counterclockwise. + + The degree of rotation (from 0 to 360) in multiples of 90. + + + + Gets or sets how the text is aligned in the widget. + + Indicates the text justification type. + + + + Gets or sets spacing between words. + + A double value that is the word spacing. + + + + An individual word in a document. + + + + + Returns a list of the word’s characters. + + A collection of values. + + + + Returns rectangles surrounding the word. + + A collection of values. + + + + Returns a list of the word’s segments. + + A collection of values that represent the word’s segments. + + + + Returns a Unicode representation of the word’s characters. + + A value. + + + + Represents a word segment in a document. + + + + + Returns a list of the word segment’s characters. + + A collection of values. + + + + Returns a rectangle surrounding the word’s segment. + + A object that is the rectangle surrounding the word’s segment. + + + + Returns a Unicode representation of the word’s segments. + + A System.String value. + + + + Represents an interactive form based on the Adobe XML Forms Architecture (XFA). + + + + + Gets the content of a XFA form. + + A object that represents the content of a XFA form. + + + + Represents a form XObject in a PDF document content. + + + + + Provides access to a stream that contains the form X-Object metadata. + + A object that represents the metadata stream of the form X-Object. + + + + Gets an Open Prepress Interface (OPI) dictionary for the form XObject. + + A PdfOpenPrepressInterface object that is the OPI dictionary. + + + + Gets the value specifying the optional content properties for the form XObject. + + A object that contains the optional content properties for the form XObject. + + + + Gets the integer key of the form XObject’s entry in the structural parent tree. + + A nullable integer value specifying the key of the form XObject’s entry + + + + A destination that positions a specific coordinate at the top left corner of the document window, and zooms a page with the specified zoom factor. + + + + + Initializes a new instance of the class with the specified parameters. + + The page to which the destination should refer. + The X coordinate of a point that is positioned at at the top left corner of the document window. + The Y coordinate of a point that is positioned at at the top left corner of the document window. + The zoom factor. + + + + Gets the X coordinate of a point that is positioned at at the top left corner of the document window. + + The X coordinate in the user coordinate system. + + + + Gets the Y coordinate of a point that is positioned at at the top left corner of the document window. + + The Y coordinate in the user coordinate system. + + + + Gets the zoom factor applied to the visible page area. + + The zoom factor. + + + + Lists values used to specify a ZUGFeRD attachment’s conformance level. + + + + + Basic level (the invoice contains basic details and additional information included as free text). + + + + + Basic WL level (invoice information is mostly required or useful for process automation). + + + + + Comfort level (the details are structured and fully automated). + + + + + EN1 6931 level (invoice information contained in the European Norm EN16931). + + + + + Extended EN16931 level. + + + + + Minimum level (minimum invoice information required on CHORUS PRO, and equivalent to a classic header OCR and manual validation data capture). + + + + + No conformance level is specified. + + + + + XRechnung level (a binding requirement for the receipt of electronic invoices for all public sector customers in Germany). + + + + + Lists values used to specify the ZUGFeRD format version. + + + + + ZUGFeRD 1.0 + + + + + ZUGFeRD 2.0.1 + + + + + ZUGFeRD 2.1 + + + + + Allows you to create PKCS#7 signatures. + + + + + Initializes a new instance of the class with specified settings. + + A stream that contains signature certificate (.pfx file format). + A password for a certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + A stream that contains signature certificate (.pfx file format). + A password for a certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + + + + Initializes a new instance of the class with specified settings. + + A stream that contains signature certificate (.pfx file format). + A password for a certificate. + Signature’s hash algorithm. + + + + Initializes a new instance of the class with specified settings. + + A stream containing signature certificate (.pfx file format). + A password for a certificate. + An object used to build a certificate chain and register the signature in the Document Security Store (DSS). + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + A stream containing signature certificate (.pfx file format). + A password for a certificate. + + + + Initializes a new instance of the class with specified settings. + + An X.509 signature certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + An X.509 signature certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + + + + Initializes a new instance of the class with specified settings. + + An X.509 signature certificate. + A signature’s hash algorithm. + + + + Initializes a new instance of the class with specified settings. + + An X.509 signature certificate. + An object used to build a certificate chain and register the signature in the Document Security Store (DSS) + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + An X.509 signature certificate. + + + + Initializes a new instance of the class with specified settings. + + A path to a signature certificate file (.pfx file format). + A password for a certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + A path to a signature certificate file (.pfx file format). + A password for a certificate. + Signature’s hash algorithm. + An object that provides a timestamp. + + + + Initializes a new instance of the class with specified settings. + + A path to a signature certificate file (.pfx file format). + A password for a certificate. + A signature’s hash algorithm. + + + + Initializes a new instance of the class with specified settings. + + A path to a signature certificate file (.pfx file format). + A password for a certificate. + An object used to build a certificate chain and register the signature in the Document Security Store (DSS). + Signature’s hash algorithm. + An object that provides a timestamp. + An object that performs Online Certificate Status Protocol (OCSP) request for a certificate. + An object that performs a Certificate Revocation List (CRL) request for a certificate. + An enumeration value type that specifies the signature’s baseline profile type. + + + + Initializes a new instance of the class with specified settings. + + A path to a signature certificate file (.pfx file format). + A password for a certificate. + + + + A base class used to create PKCS#7 signatures. + + + + + Builds the signature and returns its contents. + + The document’s hash value. + The hash algorithm’s object identifier. + The signature contents. + + + + Builds the signature for the specified document. + + A stream that contains the document to sign. + The PKCS#7 signature. + + + + Retrieves the name of the preferred signature handler. + + Preferred signature handler’s name. + + + + Returns the signature size (in bytes). + + A signature’s size (in bytes). + + + + Returns information about a signature’s format. + + The signature’s encoding and key information. + + + + Returns the signature type. + + null (Nothing in Visual Basic) + + + + Contains properties used to manage XMP metadata in PDF documents. + + + + + Contains members used to define the Adobe PDF namespace. + + + + + Gets or sets the value for the pdf:Keywords attribute. + + The keywords. + + + + Gets or sets the value for the pdf:PDFVersion attribute. + + The document’s PDF version. + + + + Gets or sets the value for the pdf:Producer attribute. + + The name of the tool used to create the document. + + + + Gets or sets the value for the pdf:Trapped attribute. + + true if the document includes trapping information; otherwise, false. + + + + Contains properties used to define the custom XMP namespace. + + + + + Initializes a new instance of the class with specified settings. + + The XMP packet to which to add the namespace. + The namespace URI. + + + + Returns an enumerator that iterates through the instance. + + A for the instance.’ + + + + Returns a value of the namespace attribute with the given name. + + The target attribute name. + The attribute value. + + + + Contains properties used to define the Dublin Core namespace. + + + + + Gets the value for the dc:Contributor attribute. + + An array of entities responsible for making contributions to the document. + + + + Gets or sets the value for the dc:Coverage attribute. + + The document topic, spatial applicability of the document, or jurisdiction under which the document is relevant. + + + + Gets the value for the dc:Creator attribute. + + An array of entities primarily responsible for creating the document. + + + + Gets the value for the dc:Date attribute. + + The date and time associated with an event in the document life cycle. + + + + Gets the value for the dc:Description attribute. + + The document content description (in different languages). + + + + Gets or sets the value for the dc:Format attribute. + + The file format, physical medium, or dimensions of the document. + + + + Gets or sets the value for the dc:Identifier attribute. + + An unambiguous reference to the document within a given context. + + + + Gets the value for the dc:Language attribute. + + A list of languages used in the document content. + + + + Gets the value for the dc:Publisher attribute. + + A list of entities responsible for making the document available. + + + + Gets the value for the dc:Relation attribute. + + A list of related resources. + + + + Gets the value for the dc:Rights attribute. + + A list of informal rights statements (in different languages). + + + + Gets or sets the value for the dc:Source attribute. + + A related resource from which the document is derived. + + + + Gets the value for the dc:Subject attribute. + + A list of descriptive phrases or keywords that specify the document content. + + + + Gets the value for the dc:Title attribute. + + The document title or name in different languages. + + + + Gets the value for the dc:Type attribute. + + The document genre or type. + + + + Contains properties used to define the PDF/A extension namespace. + + + + + Gets or sets the value for the pdfaid:conformance attribute. + + The PDF/A conformance level (A or B). + + + + Gets or sets the value for the pdfaid:part attribute. + + The PDF/A version identifier. + + + + An XMP metadata node with an array value. + + + + + Adds a new item to the array. + + The item value. + + + + Adds a new item to the array. + + The item value. + + + + Adds a new item to the array. + + The item value. + + + + Adds a new item to the array. + + The item value. + + + + Adds a new item to the array. + + The item value. + + + + Adds an empty array item to the array. + + An array item. + + + + Adds an empty array item to the array. + + the array item type. + An array item. + + + + Add a new simple value item to the array. + + An item value. + The added simple value item. + + + + Adds a new empty structure to the array. + + The added structure. + + + + Retrieves the array type. + + The array type. + + + + Clears the array. + + + + + Determines whether the array contains the specified item. + + An item to be checked. + true if the array contains the item; otherwise, false. + + + + Gets the number of items in the array. + + The number of items in the array. + + + + Gets an array value of an item located at the specified index. + + The item index. + The array item or null (Nothing in Visual Basic) if the item at the specified index is not an array. + + + + Gets a DateTime value of an item located at the specified index. + + The item index. + The item value or null (Nothing in Visual Basic) if it is not a DateTime value. + + + + Gets the Single value of an item at the specified index. + + The item index. + The item value or null (Nothing in Visual Basic) if it is not a Single value. + + + + Gets the Int32 value of an item at the specified index. + + The item index. + The item value or null (Nothing in Visual Basic) if it is not an Int32 value. + + + + Gets a simple value item at the specified index. + + The item index. + The array item or null (Nothing in Visual Basic) if the item at the specified index is not a simple value. + + + + Gets the String value of an item at the specified index. + + The item index. + The item value or null (Nothing in Visual Basic) if it is not a String value. + + + + Gets a structure item at the specified index. + + The item index. + The array item or null (Nothing in Visual Basic) if the item at the specified index is not a structure. + + + + Gets the array item at the specified index. + + The item index. + The array item at the specified index. + + + + Removes the specified item from the array. + + An item to be removed. + true if the item is removed successfully; otherwise, false. + + + + Removes an item at the specified index from the array. + + The item index. + + + + Gets the node’s value type. + + The node value type (XmpValueType.Array). + + + + Retrieves a list of array item values. + + A list of array item values. + + + + Lists values that indicate the type of array elements in the XMP packet. + + + + + Alternative array – the item order is defined by data type or application. Items cannot be reordered. + + + + + Ordered array – items are ordered by index and cannot be reordered. + + + + + The array type is undefined. + + + + + Unordered array – the array items can be reordered. + + + + + The XMP packet – an instance of the XMP data model. + + + + + Initializes a new instance of the class. + + + + + Adds a node to the XMP packet. + + The node name. + The node value. + + + + Adds a node to the XMP packet. + + The node name. + The node value. + + + + Adds a node to the XMP packet. + + The node name. + The node value. + + + + Adds a node to the XMP packet. + + The node name. + The node value. + + + + Adds a node to the XMP packet. + + The node name. + The node value. + + + + Adds a node to the XMP packet. + + The node’s qualified name (prefix:local format). + The node value. + + + + Adds a node to the XMP packet. + + The node’s qualified name (prefix:local format). + The node value. + + + + Adds a node to the XMP packet. + + The node’s qualified name (prefix:local format). + The node value. + + + + Adds a node to the XMP packet. + + The node’s qualified name (prefix:local format). + The node value. + + + + Adds a node to the XMP packet. + + The node’s qualified name (prefix:local format). + The node value. + + + + Removes all data from the XMP packet. + + + + + Indicates whether the XMP packet contains a node with the specified name. + + The target node name. + true if the packet contains the node; otherwise, false. + + + + Returns the number of elements in the XMP packet. + + The number of elements. + + + + Adds an array at the end of the packet. + + The array name. + The array type. + An empty XMP array. + + + + Adds an array at the end of the packet. + + The array name. + An empty XMP array. + + + + Adds an array at the end of the packet. + + The array’s qualified name (prefix:local format). + The array type. + An empty XMP array. + + + + Adds an array at the end of the packet. + + The array’s qualified name (prefix:local format). + An empty XMP array. + + + + Adds a simple value node at the end of the packet. + + The node name. + The node value. + true if the node value is a URI string; false if the node value is a regular string. + The simple value node. + + + + Adds a simple value node at the end of the packet. + + The node name. + The node value. + The simple value node. + + + + Adds a simple value node at the end of the packet. + + The node’s qualified name (prefix:local format). + The node value. + true if the node value is a URI string; false if the node value is a regular string. + The simple value node. + + + + Adds a simple value node at the end of the packet. + + The node’s qualified name (prefix:local format). + The node value. + The simple value node. + + + + Adds a structure at the end of the packet. + + The structure name. + An empty XMP structure. + + + + Adds a structure at the end of the packet. + + The structure’s qualified name (prefix:local format). + An empty XMP structure. + + + + Gets properties used to define a custom schema. + + An object that contains a custom schema properties. + + + + Gets properties used to define the Dublin Core namespace. + + An object that contains the Dublin Core namespace properties. + + + + Creates an XmpDocument object from the specified stream. + + A stream that contains the data for the XmpDocument object. + The resulting XmpDocument object. + + + + Creates an XmpDocument object from the specified string. + + A string to convert to an XmpDocument object. + An XmpDocument object that corresponds to the string. + + + + Gets an array node with the specified name. + + The node name. + The array node with the specified name or null (Nothing in Visual Basic) if this node is not an array. + + + + Gets an array node with the specified name. + + The node’s qualified name (prefix:local format.). + The array node with the specified name or null (Nothing in Visual Basic) if this node is not an array. + + + + Gets a Boolean value of a node with the specified name. + + The node’s name. + The node value or null (Nothing in Visual Basic) if it is not a Boolean value. + + + + Gets a Boolean value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not a Boolean value. + + + + Gets a DateTime value of a node with the specified name. + + The node name. + The node value or null (Nothing in Visual Basic) if it is not a DateTime value. + + + + Gets a DateTime value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not a DateTime value. + + + + Gets the Single value of a node with the specified name. + + The node name. + The node value or null (Nothing in Visual Basic) if it is not a Single value. + + + + Gets the Single value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not a Single value. + + + + Gets an Int32 value of a node with the specified name. + + The node name. + The node value or null (Nothing in Visual Basic) if it is not an Int32 value. + + + + Gets an Int32 value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not an Int32 value. + + + + Gets a simple value node with the specified name. + + The node name. + The simple value node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a simple value node. + + + + Gets a simple value node with the specified name. + + The node’s qualified name (prefix:local format). + The simple value node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a simple value node. + + + + Gets the String value of a node with the specified name. + + The node name. + The node value or null (Nothing in Visual Basic) if it is not a String value. + + + + Gets the String value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not a String value. + + + + Gets a structure node with the specified name. + + The node name. + The structure node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a structure. + + + + Gets a structure node with the specified name. + + The structure’s qualified name (prefix:local format). + The structure node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a structure. + + + + Returns a value of the XMP packet node with the given name. + + An object that contains the node name. + The XMP packet node with the specified name. + + + + Returns a value of the XMP packet node with the given qualified name. + + The node’s qualified name (prefix:local format). + The XMP packet node with the specified name. + + + + Gets properties used to define the PDF/A namespace. + + An object that contains PDF/A namespace properties. + + + + Gets properties used to define the Adobe PDF namespace. + + An object that contains Adobe PDF namespace properties. + + + + Registers the namespace in the XMP packet. + + The namespace URI. + The preferred prefix. + true, if the namespace is registered successfully; otherwise, false. + + + + Removes the specified node from the XMP packet. + + The node name. + true if the node is successfully removed; otherwise, false. + + + + Removes the specified node from the XMP packet. + + The node’s qualified name (prefix:local format). + true if the node is successfully removed; otherwise, false. + + + + Gets properties used to define the XMP Rights Management namespace. + + An object that contains Rights Management namespace properties. + + + + Serializes an XMP packet to a stream. + + The output stream. + An object that contains serialization options. + + + + Serializes an XMP packet to a stream. + + The output stream. + + + + Converts the object to a string. + + A string that is the XmpDocument content. + + + + Converts the object to a string with specified serialization options. + + An object that contains serialization properties. + A string that is the XmpDocument content. + + + + Retrieves a list of XMP document node values. + + A list of document node values. + + + + Gets properties used to define the XMP basic namespace. + + An object that contains XMP basic namespace properties. + + + + An alternative XMP array of simple text items with xml:lang qualifiers. + + + + + Adds a string in the specified language to the array. + + The string value. + The value language. + + + + Gets the array of language alternatives. + + An array of language alternatives. + + + + Gets a string value in the specified language. + + The target language. + The string value in the specified language. + + + + Complex XMP metadata that contains multiple XMP packets. + + + + + Retrieves the XMP packet. + + An XMP packet. + + + + Obtains a list of XMP packets. + + A list of XMP packets. + + + + Creates a metadata object from the specified data stream. + + A containing metadata. + An XmpMetadata object. + + + + Creates a metadata object from the specified string. + + A string with metadata. + An XmpMetadata object. + + + + Saves metadata to a stream. + + A stream to which to save metadata. + + + + Saves metadata to a file. + + The path to a file in which to save the result. + + + + Serializes an XMP object to a stream. + + An output stream. + An object that contains serialization options. + + + + Converts the object to a string. + + The string representation of the object. + + + + The XMP packet node name in the prefix:local format. + + + + + Determines whether the specified object is equal to the current XmpName object. + + An object to compare with the current XmpName object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether the specified object is equal to the current XmpName object. + + An object to compare with the current XmpName object. + true if the specified object is equal to the current object; otherwise, false. + + + + Generates an XMP name (prefix:local format). + + The local name. + The namespace URI (prefix). + The XMP name. + + + + Returns a number that identifies the object instance. + + An integer that identifies the color instance. + + + + Gets the name’s local name part. + + The local name. + + + + Gets the name’s prefix. + + The namespace URI (prefix). + + + + Implicitly converts an XmpName value to an value. + + The object to convert. + The conversion result. + + + + Implicitly converts a value to an XmpName value. + + An object to convert. + The result of conversion. + + + + Base class for XMP packet nodes. + + + + + Gets the node name. + + An object that contains the node name. + + + + Contains properties used to define the XMP basic namespace. + + + + + Gets or sets the value for the xmp:CreateDate attribute. + + The date and time the document was created. + + + + Gets or sets the value for the xmp:CreatorTool attribute. + + The first tool used to create the document. + + + + Gets or sets the value for the xmp:Identifier attribute. + + The array of document identifiers. + + + + Gets or sets the value for the xmp:Label attribute. + + The label to identify a document in a user-defined collection. + + + + Gets or sets the value for the xmp:MetadataDate attribute. + + The date and time any document metadata has been changed. + + + + Gets or sets the value for the xmp:ModifyDate attribute. + + The date and time the document was modified. + + + + Gets or sets the value for the xmp:Rating attribute. + + The user-assigned rating (from -1 to 5) for this document. + + + + An XMP value qualifier - metadata about the value to which it is attached. + + + + + Indicates whether the qualifier is the xml:lang qualifier. + + true if the qualifier is a language qualifier; otherwise, false. + + + + Gets or sets the qualifier value. + + The qualifier value. + + + + Contains properties used to define the XMP Rights Management namespace. + + + + + Gets or sets the value for the xmpRights:Certificate attribute. + + A Web URL for a rights management certificate. + + + + Gets or sets the value for the xmpRights:Marked attribute. + + true if this document is rights-managed; false if it is public-domain. + + + + Gets the value for the xmpRights:Owner attribute. + + The list of legal document owners. + + + + Gets the value for the xmpRights:UsageTerms attribute. + + The text instructions (in different languages) on how the document can be legally used. + + + + Gets the value for the xmpRights:WebStatement attribute. + + A Web URL for a statement of the document’s ownership and usage rights. + + + + Contains options used to control the XMP data serialization. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to replace the rdf:Description element with the rdf:ParseType=”Resource” attribute in the structure element. + + true to use the rdf:ParseType=”Resource” attribute; otherwise, false. + + + + Gets or sets whether to place the x:xmpmeta element around the rdf:RDF element. + + true to use the x:xmpmeta element; otherwise, false. + + + + An XMP metadata node with a simple value. + + + + + Gets or sets whether the node value is a URI string. + + true if the node value is a URI string; false if the node value is a regular string. + + + + Specifies a URI string as a node value. + + The URI string that is the node value. + + + + Sets a regular string as a node value. + + The node value. + + + + Gets the node’s value type. + + The node value type (XmpValueType.Simple). + + + + Gets or sets the node value. + + The node value. + + + + An XMP metadata node with a structure value. + + + + + Adds a new item to a structure. + + The item name. + The item value. + + + + Adds a new item to a structure. + + The item name. + The item value. + + + + Adds a new item to a structure. + + The item name. + The item value. + + + + Adds a new item to a structure. + + The item name. + The item value. + + + + Adds a new item to a structure. + + The item name. + The item value. + + + + Adds a new item to a structure. + + The item’s qualified name (prefix:local format). + The item value. + + + + Adds a new item to a structure. + + The item’s qualified name (prefix:local format). + The item value. + + + + Adds a new item to a structure. + + The item’s qualified name (prefix:local format). + The item value. + + + + Adds a new item to a structure. + + The item’s qualified name (prefix:local format). + The item value. + + + + Adds a new item to a structure. + + The item’s qualified name (prefix:local format). + The item value. + + + + Clears the XMP structure. + + + + + Indicates whether the XMP structure contains a node with the specified name. + + The target item name. + true if the item contains the node; otherwise, false. + + + + Gets the number of items in the structure. + + The number of items in the structure. + + + + Adds an array at the end of the structure. + + The array name. + The array type. + An empty XMP array. + + + + Adds an array at the end of the structure. + + The array name. + An empty XMP array. + + + + Adds an array at the end of the structure. + + The array’s qualified name (prefix:local format). + The array type. + An empty XMP array. + + + + Adds an array at the end of the structure. + + The array’s qualified name (prefix:local format). + An empty XMP array. + + + + Adds a simple value node at the end of the structure. + + The node name. + The node value. + true if the node value is a URI string; false if the node value is a regular string. + The simple value node. + + + + Adds a simple value node at the end of the structure. + + The node name. + The node value. + The simple value node. + + + + Adds a simple value node at the end of the structure. + + The node’s qualified name (prefix:local format). + The node value. + true if the node value is a URI string; false if the node value is a regular string. + The simple value node. + + + + Adds a simple value node at the end of the structure. + + The node’s qualified name (prefix:local format). + The node value. + The simple value node. + + + + Adds a nested structure at the end of the structure. + + The structure name. + An empty nested structure. + + + + Adds a nested structure at the end of the structure. + + The structure’s qualified name (prefix:local format). + An empty nested structure. + + + + Gets an array node with the specified name. + + The node name. + The array node with the specified name or null (Nothing in Visual Basic) if this node is not an array. + + + + Gets an array node with the specified name. + + The node’s qualified name (prefix:local format). + The array node with the specified name or null (Nothing in Visual Basic) if this node is not an array. + + + + Gets a Boolean value of an item with the specified name. + + The item name. + The item value or null (Nothing in Visual Basic) if it is not a Boolean value. + + + + Gets a Boolean value of an item with the specified name. + + The item’s qualified name (prefix:local format). + The item value or null (Nothing in Visual Basic) if it is not a Boolean value. + + + + Gets a DateTime value of an item with the specified name. + + The item name. + The item value or null (Nothing in Visual Basic) if it is not a DateTime value. + + + + Gets a DateTime value of an item with the specified name. + + The item’s qualified name (prefix:local format). + The item value or null (Nothing in Visual Basic) if it is not a DateTime value. + + + + Gets the Single value of a node with the specified name. + + The node name. + The node value or null (Nothing in Visual Basic) if it is not a Single value. + + + + Gets the Single value of a node with the specified name. + + The node’s qualified name (prefix:local format). + The node value or null (Nothing in Visual Basic) if it is not a Single value. + + + + Gets an Int32 value of an item with the specified name. + + The item name. + The item value or null (Nothing in Visual Basic) if it is not an Int32 value. + + + + Gets an Int32 value of an item with the specified name. + + The item’s qualified name (prefix:local format). + The item value or null (Nothing in Visual Basic) if it is not an Int32 value. + + + + Gets a simple value node with a specified name. + + The node name. + The simple value node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a simple value node. + + + + Gets a simple value node with a specified name. + + The node’s qualified name (prefix:local format). + The simple value node with the specified name or null (Nothing in Visual Basic) if the node with such name is not a simple value node. + + + + Gets the String value of an item with the specified name. + + The item name. + The item value or null (Nothing in Visual Basic) if it is not a String value. + + + + Gets the String value of an item with the specified name. + + The item’s qualified name (prefix:local format). + The item value or null (Nothing in Visual Basic) if it is not a String value. + + + + Gets a nested structure with a specified name. + + The structure name. + The nested structure with the specified name or null (Nothing in Visual Basic) if the item with this name is not a structure. + + + + Gets a nested structure with a specified name. + + The structure’s qualified name (prefix:local format). + The nested structure with the specified name or null (Nothing in Visual Basic) if the item with such name is not a structure. + + + + Removes the specified item from the array. + + The name of the item to be removed. + true if the item is removed successfully; otherwise, false. + + + + Removes the specified item from the array. + + The name of the item to be removed. + true if the item is removed successfully; otherwise, false. + + + + Gets the node’s value type. + + The node value type (XmpValueType.Array). + + + + Retrieves a list of structure item values. + + A list of structure item values. + + + + Base class for XMP nodes with a value. + + + + + Gets or sets the default language for the node value. + + The node value language (can be case-insensitive). + + + + Gets a list of value node qualifiers. + + A list of qualifiers. + + + + Gets the node’s value type. + + The node value type. + + + + Lists values that specify the value type of the XMP packet element. + + + + + An array value. + + + + + A simple value. + + + + + A structure value. + + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.dll b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.dll new file mode 100644 index 0000000..86a6f78 Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.xml b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.xml new file mode 100644 index 0000000..b5b8da3 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Pdf.v23.2.Drawing.xml @@ -0,0 +1,1801 @@ + + + + DevExpress.Pdf.v23.2.Drawing + + + + + Contains classes and enumerations that are used to implement the main functionality of WinForms and WPF PDF Viewers, and the PDF Document API. + + + + + Implements options used to obtain information common for annotation types. + + + + + Gets the annotation’s bounds on the page. + + Annotation bounds in the page coordinate system. + + + + Gets the annotation color. + + The annotation color. + + + + Gets the annotation’s name. + + The annotation name. + + + + Gets the page number where the annotation is located. + + The page number. + + + + Gets the annotation’s type. + + One of enumeration values that indicates the annotation type. + + + + Implements options used to obtain information common for annotation types. + + + + + Gets the markup annotation’s author. + + The annotation author. + + + + Gets the annotation contents. + + The annotation contents. + + + + Gets the date and time of the annotation’s last modification. + + The date and time of the annotation’s last modification. + + + + Obtains the annotation comments. + + A list of comments added to the annotation. + + + + Obtains the annotation reviews. + + A collection of reviews applied to the annotation. + + + + Implements options used to build all annotation types. + + + + + Gets the annotation’s type. + + An enumeration value that indicates the annotation type. + + + + Gets the annotation’s bounds on a page. + + Annotation bounds in the page coordinate system. + + + + Specifies the annotation’s color. + + The markup annotation color. + + + + Specifies the annotation contents. + + The annotation contents. + + + + Specifies whether or not to select the annotation. + + true, to select the annotation; otherwise, false (the default value). + + + + Specifies the date and time of the annotation’s last modification. + + The date and time when the annotation was last modified. + + + + Specifies the annotation name. + + The name of the annotation. + + + + Gets the number of the page on which the annotation is located. + + The page number. + + + + Implements properties used to return information about markup annotations. + + + + + Gets the date and time when the markup annotation was created. + + The date and time of the markup annotation’s creation. + + + + Gets the markup annotation opacity. + + The markup annotation opacity (from 0 to 1). + + + + Gets the markup annotation’s subject. + + A short description of the subject. + + + + Implements properties used to build markup annotations. + + + + + Gets or sets the author of a markup annotation’s author. + + The author’s name. + + + + Specifies the date and time when the markup annotation was created. + + The annotation’s creation date. + + + + Specifies the markup annotation opacity. + + Markup annotation opacity (from 0 to 1). + + + + Gets or sets a subject the markup annotation addresses.’ + + A short description of the subject. + + + + Contains properties used to return information about text annotations. + + + + + Gets the name of the annotation’s icon. + + The annotation icon’s name. + + + + Contains options used to build text annotations. + + + + + Gets the name of the annotation’s icon. + + The icon name. + + + + Contains properties used to return information about text markup annotations. + + + + + Gets a collection of quadrilateral points that encompass the annotation area. + + A list of quadrilateral points. + + + + Gets the style of a text markup annotation. + + An enumeration value that indicates the text markup style. + + + + Implements options used to build text markup annotations. + + + + + Gets a collection of quadrilateral points that encompass the annotation area. + + A list of the quadrilateral points. + + + + Gets a selected text for which a markup annotation is created. + + The selected text. + + + + Gets or sets the style of a text markup annotation. + + The enumeration value that specifies the annotation style. + + + + Contains filters that can be applied to annotations. + + + + + Initializes a new instance of the class. + + + + + Retrieves a list of authors whose annotations should be displayed. + + A list of annotation authors. + + + + Specifies whether to show checked annotations. + + true to apply this filter; otherwise, false. + + + + Clears all applied filters. + + + + + Clears all applied filters without notification. + + + + + Fires when the filter has been changed. + + + + + Specifies whether to hide all annotations and comments. + + true to hide all annotations; otherwise, false. + + + + Specifies whether to show annotations whose review status is None. + + true to apply this filter; otherwise, false. + + + + Gets or sets the text used to filter annotations. + + The text that annotations should contain. + + + + Retrieves a list of statuses by which to filter the annotations. + + A list of statuses. + + + + Retrieves a list of types by which to filter the annotations. + + A list of types. + + + + Lists values used to specify the annotation’s sort mode in the Comments pane. + + + + + Annotations are sorted by author. + + + + + Annotations are sorted by checkmark status (checked or unchecked). + + + + + Annotations are sorted by date. + + + + + Annotations are sorted by page. + + + + + Annotations are sorted by type. + + + + + Allows you to draw graphics content on a PDF page. + + + + + Adds an interactive form field as graphics content. + + An interactive form field that should be added. + + + + Adds a link that refers to the document page with the specified number. Allows you to set the page point positioned at the top left corner of the document window, and zoom factor. + + A page area (in world coordinate system) where you can add a link. + The page number. + The horizontal coordinate of a page point (in the world coordinate system) positioned at the top left corner of the document window. + The vertical coordinate of a page point (in the world coordinate system) positioned at the top left corner of the document window. + The zoom factor by which the document is scaled after you click a link. + + + + Adds a link that refers to the document page with the specified number. Allows you to set a page point positioned at the top left corner of the document window. + + A page area (in the world coordinate system) where you can add a link. + The page number. + The horizontal coordinate of a target page point (in the world coordinate system) that is positioned at the top left corner of the document window. + The vertical coordinate of a target page point (in the world coordinate system) that is positioned at the top left corner of the document window. + + + + Adds a link that refers to the document page with the specified number and zoom factor. + + A page area (in the world coordinate system) where you can add a link. + The target page number. + A zoom factor by which the document is scaled after you click a link. + + + + Adds a link that refers to the document page with the specified number. + + A page area (in world coordinate system) where you can add a link. + The page number. + + + + Adds a link to a URI at the specified page rectangle. + + A page area (in the world coordinate system) where you can add a link. + A object that is the link URI. + + + + Adds graphics to a PDF page background with the specified horizontal and vertical resolutions. + + A object that is the page where graphics are drawn (measured in points - 1/72 of an inch). + A object that represents the value, in dots per inch, for the horizontal resolution. + A object that represents the value, in dots per inch, for the vertical resolution. + + + + Adds graphics to a PDF page background. + + A object that is the page in the document where graphics are drawn (measured in points - 1/72 of an inch). + + + + Adds graphics to a PDF page foreground with the specified horizontal and vertical resolutions. + + A object that is the page in the document where graphics are drawn (measured in points - 1/72 of an inch). + A object that represents the value, in dots per inch, for the horizontal resolution. + A object that represents the value, in dots per inch, for the vertical resolution. + + + + Adds graphics to a PDF page foreground. + + A object that is the page in the document where graphics are drawn (measured in points - 1/72 of an inch). + + + + Clears all interactive form fields that were previously added to PDF graphics. + + + + + Specifies whether to convert bitmap images into JPEG to reduce the size of the resulting PDF file. + + true, to convert bitmap images to the Jpeg format; otherwise, false. + + + + The default DPI of a page that is the default size to display text and other content on the page. + + A DPI value. + + + + Draws a Bezier curve specified by four points (in the world coordinate system). + + A object that specifies the color, width, and style of the curve. + A structure that specifies the start point of the curve. + A structure that specifies the first control point of the curve. + A structure that specifies the second control point of the curve. + A structure that specifies the end point of the curve. + + + + Draws a Bezier curve specified by four points (in the world coordinate system). + + A object that specifies the color, width, and style of the curve. + A structure that specifies the start point of the curve. + A structure that specifies the first control point of the curve. + A structure that specifies the second control point of the curve. + A structure that specifies the end point of the curve. + + + + Draws a Bezier curve specified by four points (in the world coordinate system). + + A object that specifies the color, width, and style of the curve. + An array of structures that specifies points (in world coordinate system) by which you can draw a series of Bezier curves. + + + + Draws a series of Bezier curves by points from the specified array. + + A object that specifies the color, width, and style of the curve. + An array of structures that specifies points (in world coordinate system) by which you can draw a series of Bezier curves. + + + + Draws an ellipse in the specified page rectangle. + + A structure that specifies the color, width, and style of the ellipse. + A structure that specifies a page area (in world coordinate system) where you can draw an ellipse. + + + + Draws an ellipse in the specified page rectangle. + + A structure that specifies the color, width, and style of the ellipse. + A structure that specifies a page area (in world coordinate system) where you can draw an ellipse. + + + + Draws the specified image in its original size at the specified page point. + + An image to draw. + A point in world coordinate system where you can position an image. + + + + Draws the specified image part in a page rectangle. + + An image to draw. + A page rectangle in world coordinate system where you can draw an image. The image portion is scaled to fit the rectangle. + A portion of the image to draw. + Indicates the measurement units used by the srcRect parameter. + + + + Draws an image in the specified page rectangle. The image is scaled to fit this rectangle. + + An image to draw. + A page area in world coordinate system where you want to draw an image. + + + + Draws the specified image data at the specified point. + + An array of bytes with image data. + A point in world coordinate system where you can draw an image. + + + + Draws an image data in the specified page rectangle. The image is scaled to fit the rectangle. + + An image to draw. + A page area in world coordinate system where you can draw an image. + + + + Draws the specified image part in a page rectangle. + + An image to draw. + A page rectangle in world coordinate system where you can draw an image. The image portion is scaled to fit the rectangle. + A portion of the image to draw. + Indicates the measurement units used by the srcRect parameter. + + + + Draws an image from a stream at the specified page point. + + A stream with image data. + A point on the page in world coordinate system where you can draw an image. + + + + Draws an image from a stream in the specified page rectangle. The image is scaled to fit the rectangle. + + A stream with image data. + A page area in world coordinate system where you can draw an image. + + + + Draws a line that connects two points with specified coordinates. + + A object that specifies the color, width, and style of the line. + A object that specifies the x-coordinate of the first point. + A object that specifies the y-coordinate of the first point. + A object that specifies the x-coordinate of the second point. + A object that specifies the y-coordinate of the second point. + + + + Draws a line that connects two points with specified coordinates. + + A object that specifies the color, width, and style of the line. + A object that specifies the x-coordinate of the first point. + A object that specifies the y-coordinate of the first point. + A object that specifies the x-coordinate of the second point. + A object that specifies the y-coordinate of the second point. + + + + Draws a series of lines that connect points from the specified array. + + A object that specifies the color, width, and style of the lines. + An array of structures that specifies points to connect (in world coordinate system). + + + + Draws a series of lines that connect points from the specified array. + + A object that specifies the color, width, and style of the lines. + An array of structures that specifies points to connect (in world coordinate system). + + + + Draws the specified page content. + + The source page from which content is drawn. + + + + Draws the specified path on a page. + + A object that specifies the color, width, and style of the path. + A object in world coordinate system. + + + + Draws the specified path on a page. + + A object that specifies the color, width, and style of the path. + A object in world coordinate system. + + + + Draws a polygon by points from the specified array. + + A object that specifies the color, width, and style of the polygon. + An array of structures that specify the polygon vertices (in world coordinate system). + + + + Draws a polygon by points from the specified array. + + A object that specifies the color, width, and style of the polygon. + An array of structures that specify the polygon vertices (in world coordinate system). + + + + Draws a rectangle in the specified page area. + + A object that specifies the color, width, and style of the rectangle. + A structure that specifies a page area (in world coordinate system) where you can draw a rectangle. + + + + Draws a rectangle in the specified page area. + + A object that specifies the color, width, and style of the rectangle. + A structure that specifies a page area (in world coordinate system) where you can draw a rectangle. + + + + Draws text at the specified point. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + A point in the world coordinate system where you can position text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters at the specified page point. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + A point in the world coordinate system where you can position text. + + + + Draws text in the specified page rectangle. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines text font options. + An object that determines the color and texture of the drawn text. + A page rectangle in the world coordinate system where you can draw text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters in the specified page rectangle. + + A text to draw. + A object that defines the text format of the string. + A object that determines the color and texture of the drawn text. + A page rectangle in the world coordinate system where you can draw text. + + + + Draws text at the specified page point. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + The x-coordinate in the world coordinate system of a point where you can draw text. + The y-coordinate in the world coordinate system of a point where you can draw text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters at the specified point on a page. + + A text to draw. + A object that defines the text format. + A object that determines the color and texture of the drawn text. + The x-coordinate in the world coordinate system of a point where you can draw text. + The y-coordinate in the world coordinate system of a point where you can draw text. + + + + Draws text at the specified point. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + A point in the world coordinate system where you can position text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters at the specified page point. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + A point in the world coordinate system where you can position text. + + + + Draws text in the specified page rectangle. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines text font options. + An object that determines the color and texture of the drawn text. + A page rectangle in the world coordinate system where you can draw text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters in the specified page rectangle. + + A text to draw. + A object that defines the text format of the string. + A object that determines the color and texture of the drawn text. + A page rectangle in the world coordinate system where you can draw text. + + + + Draws text at the specified page point. Allows you to specify brush, font, and string parameters. + + A text to draw. + An object that defines font options. + An object that determines the color and texture of the drawn text. + The x-coordinate in the world coordinate system of a point where you can draw text. + The y-coordinate in the world coordinate system of a point where you can draw text. + An object that specifies text formatting attributes. + + + + Draws text with the specified brush and font parameters at the specified point on a page. + + A text to draw. + A object that defines the text format. + A object that determines the color and texture of the drawn text. + The x-coordinate in the world coordinate system of a point where you can draw text. + The y-coordinate in the world coordinate system of a point where you can draw text. + + + + Fills the interior of an ellipse located in the specified page rectangle. + + A object that specifies the brush used to fill the ellipse. + A structure that specifies a page area (in world coordinate system) where you can draw an ellipse. + + + + Fills the interior of an ellipse located in the specified page rectangle. + + A object that specifies the brush used to fill the ellipse. + A structure that specifies a page area (in world coordinate system) where you can draw an ellipse. + + + + Fills the interior of the specified path. + + A object that specifies the brush used to fill the path. + A object in world coordinate system. + + + + Fills the interior of the specified path. + + A object that specifies the brush used to fill the path. + A object in world coordinate system. + + + + Fills the interior of a polygon specified by array points. + + A object that specifies the brush used to fill the polygon. + An array of structures that specify the polygon vertices (in world coordinate system). + + + + Fills the interior of a polygon specified by array points. + + A object that specifies the brush used to fill the polygon. + An array of structures that specify the polygon vertices (in world coordinate system). + + + + Fills the interior of a rectangle located in the specified page area. + + A object that specifies the brush used to fill the rectangle. + A structure that specifies a page area (in world coordinate system) where you can draw a rectangle. + + + + Fills the interior of a rectangle located in the specified page area. + + A object that specifies the brush used to fill the rectangle. + A structure that specifies a page area (in world coordinate system) where you can draw a rectangle. + + + + Assigns the clip region of the object to the intersection of the current clip region and the specified page region. + + A structure that intersects the current clip region of the object (defined in world coordinate system). + + + + Gets or sets the quality of JPEG images in the resulting PDF file. + + Specifies the quality of images in the resulting PDF file. + + + + Measures the specified string when drawn with the specified font and format parameters, horizontal and vertical resolutions. + + A text to measure. + An object that defines font settings. + An object that specifies text formatting parameters. + The horizontal resolution, in dots per inch. The default value is 96. + The vertical resolution, in dots per inch. The default value is 96. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font and text formatting parameters. + + A text to measure. + An object that contains font parameters. + An object that contains text formatting parameters. + The string’s measured size. + + + + Measures a string when it is drawn with the specific font and text formatting settings. + + A string to measure. + An object that contains font parameters. + Specifies the maximum layout area for the text. + An object that contains text formatting parameters. + The horizontal resolution (in dots per inch). The default value is 96. + The vertical resolution (in dots per inch). The default value is 96. + The number of characters in the string. + The number of lines in the string. + The string’s measured size. + + + + Measures the specified string when drawn with specified font and text formatting parameters. Allows you to specify text layout size, and horizontal and vertical resolutions. + + A text to measure. + An object that defines font parameters. + The maximum layout area for the text. + An object that defines text formatting parameters. + The horizontal resolution, in dots per inch. The default value is 96. + The vertical resolution, in dots per inch. The default value is 96. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font, text layout size, and format. + + A to measure. + An object that contains font parameters. + Specifies the maximum layout area for the text. + An object that contains text formatting parameters. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font settings. + + A text to measure. + An object that contains font parameters. + The maximum layout area for the text. + The string’s measured size. + + + + Measures the specified string when drawn with specified font parameters. + + A text to measure. + An object that defines font parameters. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font and format parameters, horizontal and vertical resolutions. + + A text to measure. + An object that defines font settings. + An object that specifies text formatting parameters. + The horizontal resolution, in dots per inch. The default value is 96. + The vertical resolution, in dots per inch. The default value is 96. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font and text formatting parameters. + + A text to measure. + An object that contains font parameters. + An object that contains text formatting parameters. + The string’s measured size. + + + + Measures a string when it is drawn with the specific font and text formatting settings. + + A string to measure. + An object that contains font parameters. + Specifies the maximum layout area for the text. + An object that contains text formatting parameters. + The horizontal resolution (in dots per inch). The default value is 96. + The vertical resolution (in dots per inch). The default value is 96. + The number of characters in the string. + The number of lines in the string. + The string’s measured size. + + + + Measures the specified string when drawn with specified font and text formatting parameters. Allows you to specify text layout size, and horizontal and vertical resolutions. + + A text to measure. + An object that defines font parameters. + The maximum layout area for the text. + An object that defines text formatting parameters. + The horizontal resolution, in dots per inch. The default value is 96. + The vertical resolution, in dots per inch. The default value is 96. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font, text layout size, and format. + + A to measure. + An object that contains font parameters. + Specifies the maximum layout area for the text. + An object that contains text formatting parameters. + The string’s measured size. + + + + Measures the specified string when drawn with the specified font settings. + + A text to measure. + An object that contains font parameters. + The maximum layout area for the text. + The string’s measured size. + + + + Measures the specified string when drawn with specified font parameters. + + A text to measure. + An object that defines font parameters. + The string’s measured size. + + + + Restores the saved graphics state. + + + + + Rotates the coordinate system clockwise to the specified angle relative to its origin. + + Angle of rotation in degrees. + + + + Saves the current graphics state to the stack. + + + + + Scales the coordinate system by the specified scale factor. + + Scale factor in the x direction. + Scale factor in the y direction. + + + + Specifies how to interpret a point passed to the PdfGraphics.DrawString method as a parameter. + + Indicates the point location relative to the drawn text. + + + + Translates the coordinate system origin to the specified point. + + The x-coordinate of the translation. + The y-coordinate of the translation. + + + + Gets or sets a value which indicates whether to use kerning when drawing characters. + + true to use kerning; otherwise, false. + + + + Contains border appearance settings of an interactive form field. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies a color of an interactive form field border. + + The border color. + + + + Specifies a style of an interactive form field border. + + An enumeration value that indicates the border style. + + + + Specifies the width of the interactive form field border. + + The border width. + + + + A check box field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified parameters. + + A name of a check box field. + A page rectangle in the world coordinate system where you can draw a check box field. + + + + Specifies the shape of the marker that appears inside a check box when a user selects it. + + An enumeration value that indicates the check box marker shape. + + + + Specifies an export value of a check box field. + + An export value of a check box field. + + + + Gets or sets whether a check box is checked. + + true if the check box is checked; otherwise, false. + + + + Specifies whether to generate a down appearance that appears in a check box when the mouse button is pressed within the check box area. + + true to generate a down appearance in the check box area; otherwise, false. + + + + A base class for combo box and list box fields in PDF Graphics API. + + + + + Adds an item with the specified display and export values to a combo box or a list box field. + + A value to be added to a combo box and list box. + An export value. + + + + Adds an item with the specified display value to a combo box or a list box field. + + A that is a value to be added to combo box and list box. + + + + Clears the combo box or list box selection. + + + + + Removes all values to be added to a list box or combo box field. + + + + + Selects an item in a combo box or a list box by its export value. + + The item’s export value. + true, if the combo box or list box item was successfully selected; otherwise, false. + + + + Selects or unselects an item in a combo box of a list box field by its index. + + The zero-based index of the item that should be selected or unselected. + true, to select the item; false to unselect the item. + + + + A combo box field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified parameters. + + The name of a combo box field. + A page area in the world coordinate system where you can draw a combo box. + + + + Specifies whether to include an editable text box in the combo box. + + true to include an editable text box; otherwise, false to include only a drop-down list. + + + + Obtains value format options of a field. + + An object that allows you to specify the value format. + + + + A base class for common form field types (text box, check box, list box, combo box, and signature) in PDF Graphics API. + + + + + Specifies a page rectangle in the world coordinate system where the form field is located on a page. + + A form field rectangle. + + + + Specifies the horizontal alignment of the form field’s text. + + An enumeration value that indicates the text alignment type. + + + + A base class for all interactive form fields in PDF Graphics API. + + + + + Obtains appearance settings of a form field. + + An object that specifies appearance options. + + + + Creates a combo box with the specified name in the target page area. + + A name of a combo box field. + A page rectangle in the word coordinate system where you can draw a form field. + The created combo box field. + + + + Creates a list box field with the specified name in the target page area. + + A name of a list box field. + A page rectangle in the word coordinate system where you can draw a form field. + The created list box field. + + + + Creates a radio group field with the specified name. + + A name of a radio group field. + The created radio group field. + + + + Creates a signature field with the specified name in the target page area. + + A name of a signature field. + A page rectangle in the word coordinate system where you can draw a form field. + The created signature field. + + + + Creates a text box with the specified name in the target page area. + + A that specifies the name of a text box field. + A page rectangle in the word coordinate system where you can draw a form field. + The created text box field. + + + + Specifies form field’s name. + + The field name. + + + + Specifies whether a form field is printable. + + true, if a form field can be printed on a page, otherwise, false. + + + + Gets or sets whether the interactive form field is read-only. + + true if the field is read-only; otherwise, false. + + + + Gets or sets whether to force users to complete a form field. + + true to mark the form field as required; otherwise, false. + + + + Specifies a form field’s rotation angle. + + An enumeration value that indicates a rotation degree (counterclockwise relative to a page). + + + + Specifies a form field’s tooltip text. + + A text displayed in the form field’s tooltip. + + + + Specifies whether a form field is visible on a page. + + true if a form field is visible; otherwise, false. + + + + Contains appearance settings of an interactive form field. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the form field’s background color. + + A value that specifies the interactive form field’s background color. + + + + Specifies the border appearance settings for an interactive form field. + + An object that contains border appearance parameters. + + + + Specifies a font family name for an interactive form field. + + A font family name. + + + + Specifies the font size of the interactive form field. + + Font size. + + + + Specifies the font style of the form field. + + Font style. + + + + Specifies the foreground color of the interactive form field. + + Foreground color. + + + + A list box field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified parameters. + + The name of a list box field. + A page area in the world coordinate system where you can draw a list box. + + + + Gets or sets whether to enable users to select multiple items in the list box. + + true to enable multiple selection; otherwise, false. + + + + Specifies the index of the first visible item in the list box field. + + A zero-based index of the first visible item in the list box. + + + + A radio group field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified radio group field name. + + A name of a radio group field. + + + + Adds a radio button with the specified name to the radio group field and places it in the specified page area. + + A name of a radio button. + A page rectangle in the world coordinate system where you can draw the radio button. + + + + Gets or sets the radio button style. + + An enumeration value that determines the style of a radio button in a radio group. + + + + Removes all radio buttons from the radio group field. + + + + + Gets the number of radio buttons in the radio group field. + + The number of radio buttons in the radio group field. + + + + Specifies index of the selected item in radio group field. + + The zero-based index of the radio group’s selected item. + + + + Specifies whether to generate a down appearance that appears when the mouse button is pressed within the radio button area. + + true, if a down appearance is generated within the radio button area; otherwise, false. Default value is true. + + + + A signature form field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified parameters. + + A name of a signature form field. + A page rectangle in the world coordinate system where you can draw a form field. + + + + Specifies an image displayed in the signature form field. + + An image displayed in the signature form field. + + + + Specifies an image displayed in the signature form field. + + A object that is an image displayed in the signature form field. + + + + Specifies the vertical alignment of the string in the signature field. + + An enumeration value that indicates the vertical line alignment. + + + + Specifies whether to stretch an image to fill the signature field rectangle. + + true to stretch an image to fill the field rectangle; otherwise, false. + + + + Specifies the text displayed in a signature field. + + The text displayed in the signature field. + + + + A text box field in PDF Graphics API. + + + + + Initializes a new instance of the class with the specified parameters. + + A name of a text box field. + A page area in the world coordinate system where you can draw a text box field. + + + + Specifies the maximum text length for a text box field. + + A positive integer that is the maximum number of characters allowed in a text box field. The value 0 indicates an unlimited number of characters. + + + + Specifies whether the text box field can contain multiple lines. + + true, if the text box field can contain multiple lines of text; otherwise, false. + + + + Gets or sets whether to scroll the text field when the text does not fit the field rectangle. + + true to allow scrolling; otherwise, false. + + + + Gets or sets whether to check spelling in the text form field. + + true to enable spell check; otherwise, false. + + + + Specifies text of the text box field. + + Text displayed in the text box field. + + + + Specifies the text form field input type. + + An enumeration value that indicates the input type. + + + + Obtains value format options of a form field. + + An object that allows you to specify the value format. + + + + Specifies how images are exported to PDF format. + + + + + The resulting Jpeg image quality is high. + + + + + The resulting Jpeg image quality is the highest. + + + + + The resulting Jpeg image quality is low. + + + + + The resulting Jpeg image quality is the lowest. + + + + + The resulting Jpeg image quality is medium. + + + + + Contains rendering parameters used to export a PDF page to a Bitmap image. + + + + + Creates a new PdfPageRenderingParameters instance with the specified image’s largest dimension length. + + The largest dimension length, in pixels. + A new PdfPageRenderingParameters instance with the specified LargestEdgeLength property. + + + + Creates a new PdfPageRenderingParameters instance with the specified image DPI. + + An image DPI. + A new PdfPageRenderingParameters instance with the specified Dpi property. + + + + Obtains the predefined resolution of a converted page. + + An image DPI. + + + + Gets the length of an image’s largest dimension. + + The largest dimension length, in pixels. + + + + Provides the additional printer settings to a PDF Viewer. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A object. + + + + Gets or sets whether to enable the legacy printing engine. + + true to use the old printing engine; otherwise - false. + + + + Specifies the PDF document page numbers to be printed. + + An array of integer values that correspond to page numbers. + + + + Specifies the orientation of pages to be printed. + + A value. The default value is PdfPrintPageOrientation.Auto. + + + + Specifies the dpi value used to print the PDF document. + + A value which represents the printing dpi. + + + + Gets or sets a value which indicates whether to print the document content in grayscale. + + true to print a document content in grayscale; false the current printer settings are used. + + + + Gets or sets whether to print text markup annotations (sticky notes). + + true to print sticky notes; otherwise, false. + + + + Gets or sets whether to print text as character outlines in the DirectX printing engine. + + true to print text as outlines; otherwise, false. + + + + Specifies the percentage scale factor of the document page to be printed. + + A value which represents the scale factor of the document page (the scale is measured as a percentage). + + + + Specifies the page scale mode when a document is printing. + + A value. + + + + Provides access to the standard .NET Framework printer settings. + + A object containing the standard .NET Framework printer settings. + + + + Provides data for the PdfViewer.PrintPage and PdfDocumentProcessor.PrintPage events. + + + + + Returns the total number of pages which were sent to the printer. + + An integer value which represents the total number of pages which were sent to the printer. + + + + Returns the page number of the currently printed page. + + An integer value that is the page number. + + + + A method that will handle the PdfViewer.PrintPage and PdfDocumentProcessor.PrintPage events. + + The event source. This parameter identifies either the or which raised the event. + A object that contains event data. + + + + Lists the available document orientation modes. + + + + + The orientation is defined automatically to fit the page content to the specific paper type. + + + + + Orientation of the document pages is landscape. + + + + + Orientation of the document pages is portrait. + + + + + Lists the available document scale modes. + + + + + A printed page is not scaled. + + + + + A printed page is scaled by a specified percentage scale factor. + + + + + A printed page is scaled to fit a specific paper size. + + + + + Provides data for the PdfViewer.QueryPageSettings and PdfDocumentProcessor.QueryPageSettings events. + + + + + Gets the page number in a document. + + An integer value, specifying the page number. + + + + Gets the size of the current page. + + A value. + + + + Gets or sets a value which indicates whether to print the document content in grayscale. + + true to print a document content in grayscale; false the current printer settings are used. + + + + A method that will handle the PdfDocumentProcessor.QueryPageSettings and PdfViewer.QueryPageSettings events. + + The event source. This parameter identifies either the or which raised the event. + A object that contains event data. + + + + Lists values used to specify the rendering engine. + + + + + Default rendering engine. + + + + + DirectX hardware rendering engine. + + + + + DirectX software rendering engine. + + + + + GDI/GDI+ rendering engine. + + + + + Skia graphics engine. + + + + + Defines extension methods for the IPdfViewerAnnotationBuilder interface. + + + + + Casts the IPdfViewerAnnotationBuilder object to the IPdfViewerMarkupAnnotationBuilder object. + + Current IPdfViewerAnnotationBuilder object. + The object that contain information about the markup annotation. + + + + Casts the IPdfViewerAnnotationBuilder object to the IPdfViewerTextAnnotationBuilder object. + + Current IPdfViewerAnnotationBuilder object. + The IPdfViewerTextAnnotationBuilder object that contains text annotation parameters. + + + + Casts the IPdfViewerMarkupAnnotationBuilder object to the IPdfViewerTextAnnotationBuilder object. + + Current IPdfViewerMarkupAnnotationBuilder object. + The IPdfViewerTextAnnotationBuilder object that contains text annotation parameters. + + + + Casts the IPdfViewerAnnotationBuilder object to the IPdfViewerTextMarkupAnnotationBuilder object. + + Current IPdfViewerAnnotationBuilder object. + The IPdfViewerTextMarkupAnnotationBuilder object that contains text markup annotation parameters. + + + + Casts the IPdfViewerMarkupAnnotationBuilder object to the IPdfViewerTextMarkupAnnotationBuilder object. + + Current IPdfViewerMarkupAnnotationBuilder object. + The IPdfViewerTextMarkupAnnotationBuilder object that contains text markup annotation parameters. + + + + Defines extension methods for the IPdfViewerAnnotation interface. + + + + + Casts the IPdfViewerAnnotation object to the IPdfViewerMarkupAnnotation object + + Current IPdfViewerAnnotation object. + The IPdfViewerMarkupAnnotation object that contains markup annotation parameters. + + + + Casts the IPdfViewerAnnotation object to the IPdfViewerTextAnnotation object. + + Current IPdfViewerAnnotation instance. + The IPdfViewerTextAnnotation object that contains text annotation parameters. + + + + Casts the IPdfViewerMarkupAnnotation object to the IPdfViewerTextAnnotation object. + + Current IPdfViewerMarkupAnnotation instance. + The IPdfViewerTextAnnotation object that contains text annotation parameters. + + + + Casts the IPdfViewerAnnotation object to the IPdfViewerTextMarkupAnnotation object. + + Current IPdfViewerAnnotation object. + The IPdfViewerTextMarkupAnnotation object that contains text markup annotation parameters. + + + + Casts the IPdfViewerMarkupAnnotation object to the IPdfViewerTextMarkupAnnotation object. + + Current IPdfViewerMarkupAnnotation instance. + The IPdfViewerTextMarkupAnnotation object that contains text markup annotation parameters. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.dll b/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.dll new file mode 100644 index 0000000..1895d8f Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.xml b/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.xml new file mode 100644 index 0000000..32a65b3 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Printing.v23.2.Core.xml @@ -0,0 +1,27784 @@ + + + + DevExpress.Printing.v23.2.Core + + + + + Contains classes implementing the common data management functionality for DevExpress controls. + + + + + Contains classes that provide service model functionality to a report service. + + + + + Contains classes that provide data contracts and client factory functionality to the report and export services. + + + + + If implemented by a class, provides a service contract for an export service client. + + + + + Starts clearing the content of the specified document. + + A object, identifying the document. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the exported document. + + An object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the current status of the exported document. + + An object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts the initial phase of asynchronous document export. + + A object. + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Ends clearing the content of a document. + + An object containing information about the status of an asynchronous operation. + + + + Ends obtaining the exported document. + + An object containing information about the status of an asynchronous operation. + A array containing document data. + + + + Ends obtaining the current status of the exported document. + + An object containing information about the status of an asynchronous operation. + An structure. + + + + Ends the initial phase of asynchronous document export. + + An object containing information about a status of an asynchronous operation. + An object. + + + + If implemented by a class, provides a service contract for the . + + + + + Starts obtaining the document build status. + + A object, identifying the document. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the document data. + + A object, identifying the document. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the parameter lookup values. + + An value. + An array of objects. + An array of values, specifying the parameter paths (for example, “subreport1.subreportParameter1”). + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the document pages. + + A object. + An array of integer values. + A enumeration value. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the printed document. + + A object, identifying the printed document. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the status of the printed document. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the report parameters. + + An object, identifying the report. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts the initial phase of asynchronously building the report. + + An object, identifying the report. + A object, storing the arguments required to create the report. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts the initial phase of asynchronously printing of the specified document. + + A object. + A enumeration value. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts the terminal phase of asynchronously building the report. + + A object that identifies the report document. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts the terminal phase of asynchronously printing the document. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Ends obtaining the document build status. + + An object containing information about the status of an asynchronous operation. + A structure. + + + + Ends obtaining the document data. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends obtaining the parameter lookup values. + + An object containing information about the status of an asynchronous operation. + An array of objects. + + + + Ends obtaining the document pages. + + An object containing information about the status of an asynchronous operation. + A array. + + + + Ends obtaining the printed document. + + An object containing information about the status of an asynchronous operation. + A array. + + + + Ends obtaining the status of the printed document. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends obtaining the report parameters. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends the initial phase of asynchronously building the report. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends the initial phase of asynchronously printing the document. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends the terminal phase of asynchronously building the document. + + An object containing information about the status of an asynchronous operation. + + + + Ends the terminal phase of asynchronously printing the document. + + An object containing information about the status of an asynchronous operation. + + + + If implemented by a class, provides the client-side functionality for a WCF Report Service. + + + + + Starts clearing the document (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document has been cleared. + + + + + Starts obtaining the document build status (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the created document’s status has been obtained. + + + + + Starts obtaining the document data (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document data has been obtained. + + + + + Starts obtaining the exported document (asynchronously). + + An object, identifying the exported document. + A value, containing information about the asynchronous operation. + + + + Occurs when the exported document has been obtained. + + + + + Starts obtaining the exported document’s status (asynchronously). + + An object, identifying the exported document. + A value, containing information about the asynchronous operation. + + + + Occurs when the exported document’s status has been obtained. + + + + + Asynchronously obtains a collection of parameter values assigned to a lookup editor. + + An value. + An array of objects. + An array of values, specifying the parameter paths (for example, “subreport1.subreportParameter1”). + A value, containing information about the asynchronous operation. + + + + Occurs when a lookup editor has finished obtaining the appropriate parameter values. + + + + + Starts obtaining the document pages (asynchronously). + + A object, identifying the document. + An array of integer values, specifying the document pages. + A enumeration value, specifying the markup compatibility. + A value, containing information about the asynchronous operation. + + + + Occurs when the document pages have been obtained. + + + + + Starts obtaining the printed document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the printed document has been obtained. + + + + + Starts obtaining the status of the printed document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the printed document’s status has been obtained. + + + + + Starts obtaining the report parameters (asynchronously). + + An object, identifying the report. + A value, containing information about the asynchronous operation. + + + + Occurs when the report parameters have been obtained. + + + + + Starts building the report (asynchronously). + + An object, identifying the report. + A object, storing the arguments required to create the report. + A value, containing information about the asynchronous operation. + + + + Occurs when the document build has started. + + + + + Starts exporting the document (asynchronously). + + A object, identifying the document. + A object, storing the arguments required to export the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document export has started. + + + + + Starts printing the document (asynchronously). + + A object, identifying the document. + A enumeration value, specifying the markup compatibility. + A value, containing information about the asynchronous operation. + + + + Occurs when the document printing has started. + + + + + Stops building the document (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document build has stopped. + + + + + Stops printing the document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document printing has stopped. + + + + + If implemented by a class, supports automatic creation on the client side. + + + + + Provides the client-side functionality for a WCF Report Service. + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the interface. + + + + Starts clearing the document (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document has been cleared. + + + + + Starts obtaining the document build status (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the created document’s status has been obtained. + + + + + Starts obtaining the document data (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document data has been obtained. + + + + + Starts obtaining the exported document (asynchronously). + + An object, identifying the exported document. + A value, containing information about the asynchronous operation. + + + + Occurs when the exported document has been obtained. + + + + + Starts obtaining document export status (asynchronously). + + An object, identifying the exported document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document export status has been obtained. + + + + + Returns a collection of parameter values assigned to a lookup editor. + + An value. + An array of objects. + An array of values, specifying the parameter paths (for example, “subreport1.subreportParameter1”). + A value, containing information about the asynchronous operation. + + + + Asynchronously obtains a collection of parameter values assigned to a lookup editor. + + An value. + An array of objects. + An array of values, specifying the parameter paths (for example, “subreport1.subreportParameter1”). + A value, containing information about the asynchronous operation. + + + + Occurs when a lookup editor has finished obtaining the appropriate parameter values. + + + + + Starts obtaining the document pages (asynchronously). + + A object, identifying the document. + An array of integer values, specifying the document page indexes. + A enumeration value, specifying the markup compatibility. + A value, containing information about the asynchronous operation. + + + + Occurs when the document pages have been obtained. + + + + + Starts obtaining the printed document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the printed document has been obtained. + + + + + Starts obtaining the status of the printed document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the printed document’s status has been obtained. + + + + + Starts obtaining the report parameters (asynchronously). + + An object, identifying the report. + A value, containing information about the asynchronous operation. + + + + Occurs when the report parameters have been obtained. + + + + + Starts building the report (asynchronously). + + An object, identifying the report. + A object, storing the arguments required to create the report. + A value, containing information about the asynchronous operation. + + + + Occurs when the document build has started. + + + + + Starts exporting the document (asynchronously). + + A object, identifying the document. + A object, storing the arguments required to export the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document export has started. + + + + + Starts printing the document (asynchronously). + + A object, identifying the document. + A enumeration value, specifying the markup compatibility. + A value, containing information about the asynchronous operation. + + + + Occurs when the document printing has started. + + + + + Stops building the document (asynchronously). + + A object, identifying the document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document build has stopped. + + + + + Starts printing the document (asynchronously). + + A object, identifying the printed document. + A value, containing information about the asynchronous operation. + + + + Occurs when the document printing has stopped. + + + + + Supports automatic creation on the client side. + + + + + Initializes a new instance of the class with the specified remote address and binding. + + An object. + A object. + + + + Initializes a new instance of the class with the specified remote address. + + An object. + + + + Initializes a new instance of the class with the specified endpoint configuration name and remote address. + + A value, specifying the endpoint configuration name. + An object. + + + + Initializes a new instance of the class with the specified endpoint configuration name. + + A value, specifying the endpoint configuration name. + + + + Creates a . + + An object implementing the interface (typically, this is a object). + + + + Contains DTO classes required for client-server interaction with the . + + + + + Represents a structure which stores the information about a document’s build status. + + + + + Identifies the document. + + A object. + + + + Specifies the service fault. + + A object. + + + + Specifies the current number of pages in the created document. + + An integer value, specifying the number of pages. + + + + Specifies the current progress of the document creation. + + An integer value, specifying the progress position, in percents. + + + + Specifies the task status. + + A enumeration value. + + + + For internal use. Contains information about the document. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Specifies the available document export modes. + + + + + For internal use. + + + + + For internal use. Checks whether or not it is possible to modify the page settings. + + A Boolean value. + + + + For internal use. Specifies the document map. + + + + + For internal use. + + + + + For internal use. Specifies the document export options. + + + + + For internal use. + + + + + For internal use. Specifies the document name. + + + + + For internal use. Specifies the serialized page data. + + + + + Stores the arguments required to export a document (its format and export options). + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides the information about a request to export a document on the server. + + A value. + + + + Specifies the document’s export format. + + An enumeration value. + + + + Specifies the export options of a document, serialized to a array. + + An array of values. + + + + Identifies the report document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified value. + + A value. It is assigned to the DocumentId.Value property. + + + + Assigns an unique ID to the document. + + A object. + + + + Returns the textual representation of . + + A value. + + + + Specifies the document ID. + + A value. + + + + Contains information that identifies the exported document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified value. + + A value. It is assigned to the ExportId.Value property. + + + + Assigns an unique ID to the exported document. + + An object. + + + + Returns the textual representation of . + + A value. + + + + Specifies the document ID. + + A value. + + + + Contains information about the status of the exported document. + + + + + Identifies the exported document. + + An object. + + + + Details the specifics of an export service fault. + + A object. + + + + Specifies the current progress of the document export. + + An integer value, specifying the progress position. + + + + Details the current status of an exported document. + + A enumeration value. + + + + The report identifier. + + + + + Lists the values that specify the compatibility mode of a document. + + + + + The document is HTML-compatible. + + + + + The document is PNG-compatible. + + + + + The document is PRNX-compatible. + + + + + The document is Silverlight-compatible. + + + + + The document is WPF-compatible. + + + + + Stores the parameter look-up values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the collection of parameter lookup values. + + A object. + + + + Specifies the parameter path, relative to its parent container (e.g., “subreport1.subreportParameter1” for a subreport’s parameter, or “parameter1” for a report’s parameter). + + A value, specifying the parameter path (e.g., “subreport1.subreportParameter1”). + + + + Identifies the printed document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified value. + + A value, specifying the document’s ID. This value is assigned to the PrintId.Value property. + + + + Assigns an unique ID to the printed document. + + A object. + + + + Returns the textual representation of . + + A value. + + + + Specifies the printed document’s ID. + + A value, identifying the document. + + + + Contains the information related to the current status of a printed document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies information about the service fault that occurred while printing the document. + + A object. + + + + Identifies the printed document. + + A object. + + + + Specifies the progress position of the current task (as percentage). + + An integer value. + + + + Specifies information about the current service task status. + + A enumeration value. + + + + Stores the arguments required to create a report (its watermark and page settings, as well as parameters). + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. + + + + + Provides the information about a request to export a document on the server. + + A value. + + + + For internal use. + + + + + Specifies the report parameters, serialized to a array. + + An array of objects. + + + + Specifies the contents of a page, serialized to a array. + + A array. + + + + Specifies the watermark settings of a page, serialized to a array. + + A array. + + + + For internal use. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Assigns the settings of a specified parameter to the current parameter. + + A object whose settings to assign to the current parameter. + + + + For internal use. Specifies the parameter description. + + A value. + + + + For internal use. + + + + + For internal use. Specifies the collection of values for the parameter‘s look-up editor. + + A object. + + + + Specifies whether or not a parameter can have multiple values. + + true, if a parameter can have multiple values; otherwise, false. + + + + For internal use. Specifies the parameter name. + + A value. + + + + For internal use. Specifies the parameter path, relative to its parent container (e.g., “subreport1.subreportParameter1” for a subreport’s parameter, or “parameter1” for a report’s parameter). + + A value, specifying the parameter path (e.g., “subreport1.subreportParameter1”). + + + + For internal use. + + + + + For internal use. Specifies the parameter value. + + A type. + + + + For internal use. Specifies the parameter visibility. + + A Boolean value. + + + + For internal use. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the parameters available in a report. + + An array of objects. + + + + For internal use. Specifies whether should wait for a user to submit parameter values, or pass the default values to the report. + + true to wait until a user submits parameter value(s); otherwise false. + + + + Contains information about the service faults. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified exception. + + An object. + + + + Specifies the full message of the service fault. + + A value. + + + + Specifies the short message of the service fault. + + A value. + + + + Returns the textual representation of . + + A value. + + + + Lists the values that describe various task statuses. + + + + + The task is compete. + + + + + The task is fault. + + + + + The task is in progress. + + + + + Identifies the uploaded document resources, stored in the PRNX format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified resources. + + A value. + + + + Assigns an unique ID to the uploaded resources. + + An object. + + + + Returns the textual representation of . + + A value. + + + + Specifies the document resources. + + A value, specifying the document resources. + + + + For internal use. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + If implemented by a class, provides the service contract to a report parameter on the client side. + + + + + Provides the parameter description. + + A value, describing the parameter. + + + + Specifies whether or not a parameter can have multiple values. + + true, if a parameter can have multiple values; otherwise, false. + + + + Specifies the parameter name. + + A value, identifying the parameter. + + + + Classifies the parameter based on the data type implied in its value. + + A value, specifying the parameter data type. + + + + Assigns a fixed value to the parameter. + + A that is the parameter value. + + + + Specifies whether or not the parameter is visible and its value is requested in a Document Preview. + + true, to make the parameter visible; otherwise false. + + + + If implemented by a class, provides information about report parameters. + + + + + Counts the parameters that are available in a collection. + + An integer value, specifying the parameter count. + + + + Obtains an individual parameter by its path. + + A value. + An object implementing the interface. + + + + Contains classes that provide basic functionality to documents published using the control. + + + + + For internal use. + + + + + For internal use. Occurs after all document pages have been created. + + + + + For internal use. + + + + + For internal use. Occurs before document pages are created. + + + + + For internal use. + + + + + For internal use. Occurs when any exception is raised during document creation. + + + + + For internal use. + + + + + For internal use. Occurs when a Document Viewer receives a document change notification. + + + + + For internal use. Gets a value indicating whether or not the document is being created. + + true if the document creation isn’t finished; otherwise, false. + + + + For internal use. Indicates whether or not the document is empty (i.e., does it contain at least one page). + + true if the document is emtpy; otherwise, false. + + + + For internal use. Specifies the orientation of the document’s content. + + true, if the right-to-left layout is enabled; otherwise, false. + + + + For internal use. + + + + + For internal use. + + A collection of objects implementing the interface. + + + + For internal use. + + An object implementing the interface. + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + Contains settings controlling data export from controls. + + + + + Contains values that enumerate possible ways of exporting bands and columns from Banded Views. + + + + + The layout of grid bands and columns is preserved in the output worksheet. + + + + + + Bands and columns are stretched out in a single line in the output worksheet. Bands are presented in the output by worksheet collapsible columns without data. + + + + + + Columns from all visible grid bands are stretched out in a single line in the output worksheet. Grid bands are not added to the output. + + + + + + Provides data for the XlsExportOptionsEx.BeforeExportTable and XlsxExportOptionsEx.BeforeExportTable events. + + + + + Initializes a new instance of the class. + + + + + Gets the object that encapsulates a native Excel table to which data is exported. + + The object that encapsulates a native Excel table to which data is exported. + + + + Gets or sets whether to use the native Excel table footer (supports only a single line of summaries) or emulate this footer using formulas (multi-line summaries are supported in this mode). + + true, to use the native Excel table footer; otherwise, false. + + + + Provides data for the XlsExportOptionsEx.CustomizeSheetHeader, XlsExportOptionsEx.CustomizeSheetFooter, XlsxExportOptionsEx.CustomizeSheetHeader and XlsxExportOptionsEx.CustomizeSheetFooter events. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to an object that contains methods used to modify an exported worksheet. + + An object that exposes the interface. + + + + Provides data for events that allow cells in the export output to be customized. + + + + + Initializes a new instance of the class. + + + + + Specifies the hyperlink, which belongs to the currently processed cell. + + A , that specifies the processed cell’s hyperlink. + + + + Gets or sets information on the summary calculated in the currently processed cell. This property is in effect only for summary cells. + + An object that contains information on the summary calculated in the currently processed cell. + + + + Specifies the value of the cell currently being processed. + + An object which represents the processed cell’s value. + + + + Provides data for events that allow cells in the export output to be customized. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the type of the current cell in the export document. + + The type of the current cell in the export document. + + + + Gets or sets the data source field name to which the current cell corresponds. + + The data source field name. + + + + Gets or sets the object that defines the cell’s formatting settings (font, alignment, background color, format string, etc.) + + The object that defines the cell’s formatting settings. + + + + Provides data for events that allow cells in the export output to be customized. + + + + + Initializes a new instance of the class. + + + + + Allows you to get information on the currently processed column object. + + The currently processed column object. + + + + Allows you to get information on the currently processed row object. + + The currently processed row object. + + + + Represents a method for handling CustomizeCell events that take a object as a parameter. + + Data for the event. + + + + Provides data for the XlsExportOptionsEx.CustomizeDocumentColumn and XlsxExportOptionsEx.CustomizeDocumentColumn events. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the data field’s name for the current column. + + A string that is the name of the data field. + + + + Gets or sets the worksheet column. + + An object that is the individual worksheet column. + + + + Provides data used to identify elements of controls during an export procedure. + + + + + Initializes a new instance of the class. + + + + + Gets the source control being exported. + + The control being exported. + + + + Gets the data source row index to which the current cell belongs. + + A zero-based index of the current row in the underlying data source. + + + + Gets the index of the row in the export output to which the current cell is exported. + + A zero-based integer value that specifies the index of the row in the export output. + + + + Gets or sets whether the event is handled, and thus your cell customizations will be applied. + + true if the event is handled, and thus your cell customizations will be applied; false if your cell customizations (if any) will be ignored, and the cell will be exported using the default settings. + + + + Gets the handle (identifier) of the current data row in the source control. + + The handle of the current data row in the source control. + + + + Provides data for the XlsExportOptionsEx.DocumentColumnFiltering and XlsxExportOptionsEx.DocumentColumnFiltering events. + + + + + Initializes a new instance of the class. + + + + + Gets the field name of the currently processed data column. + + The column’s field name. + + + + Specifies the column index among exported columns. + + A zero-based index of the currently exported column. + + + + Gets or sets the filter to apply to the currently processed column. + + The filter to apply to the column. + + + + Represents a method that will handle the XlsExportOptionsEx.DocumentColumnFiltering and XlsxExportOptionsEx.DocumentColumnFiltering events. + + An object that provides data for the event. + + + + Contains settings that regulate data export from controls. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the default mode of a control’s data export to XLS(x) and CSV formats. Choosing the export mode is only supported for certain controls. + + The default export mode. + + + + Gets or sets whether to encode potentially dangerous content when it is exported to a CSV file. + + True, to encode potentially dangeorous content; otherwise, False. Default, to follow the default behavior. + + + + Lists the values corresponding to the different export modes available when saving a document to the XLS, XLSX and CSV formats. + + + + + Export type that uses a new data export engine that features improved performance and memory usage. When exporting to XLS and XLSX formats, specific data-shaping options (e.g., summaries, filtering, sorting, data groups and lookup values) of a source control are retained in the export output. When exporting to CSV format, the control’s data shaping options are not included in the export document, which simplifies subsequent analysis and processing of text data. + The layout of control elements may not be retained in the export document. Other limitations also apply. + Not all controls support the DataAware export mode. + + + + + The default export mode. + For the ExportSettings.DefaultExportType property, the Default value is equivalent to the DataAware value. + If the XlsxExportOptionsEx.ExportType, XlsExportOptionsEx.ExportType or CsvExportOptionsEx.ExportType property is set to Default, the actual export mode is specified by the ExportSettings.DefaultExportType property. + + + + + Export type that uses the export engine of the XtraPrinting library. + When exporting to XLS and XLSX formats, the layout of control elements is retained in the export document; specific data shaping options are not retained, compared to the DataAware export mode. + + + + + Lists values that specify the expanded state of data groups in the exported document. + + + + + Collapse all data groups. + + + + + Data groups are collapsed and expanded as they are in the source control. + + + + + Expand all data groups. + + + + + Provides data for the XlsExportOptionsEx.SkipFooterRow and XlsxExportOptionsEx.SkipFooterRow events. + + + + + Initializes a new instance of the class. + + + + + Gets the type of the currently processed summary footer. + + A value that identifies the type of the currently processed summary footer. + + + + Gets the field name of the grouping column to which the currently processed group summary footer corresponds. + + The field name of the corresponding grouping column. + + + + Gets the hierarchy level of the currently processed group summary footer. + + The zero-based integer value that specifies the hierarchy level of the currently processed group summary footer. + + + + Gets the index of the currently processed line in a multi-line summary footer. + + The zero-based index of a line in a multi-line summary footer. + + + + Gets or sets whether to hide the currently processed summary footer (or multi-line summary footer’s line). + + true, to hide the current row/line; otherwise, false. + + + + Gets the handle of the currently processed group footer. These handles match group row handles in the , + + The handle of the currently processed group footer + + + + Represents a method that will handle the XlsExportOptionsEx.SkipFooterRow and XlsxExportOptionsEx.SkipFooterRow events. + + The event’s data. + + + + Contains classes and interfaces that constitute the Excel Export Library used for generating spreadsheet files. + + + + + Represents a single cell in a worksheet. + + + + + Applies the specified formatting settings to the cell. + + An object that specifies format characteristics to be applied to the cell. + + + + Gets the index of the column that contains the current cell. + + A zero-based integer value that specifies the index of the column containing the current cell. + + + + Gets or sets cell format characteristics. + + An object that specifies format characteristics applied to the cell. + + + + Returns or specifies whether a cell value is prefixed with a single quote. + + true if the cell contains a leading quote; otherwise, false. + + + + Gets the position of the current cell in a worksheet. + + An object specifying coordinates of a cell in a worksheet. + + + + Gets the index of the row that contains the current cell. + + A zero-based integer value that specifies the index of the row containing the current cell. + + + + Assigns the specified formula to a cell. + + An object with the interface which can be transformed into an expression. + + + + Assigns the specified formula expression to a cell. + + A object that is a collection of syntactic tokens (PTGs, an acronym of “parsed thing”). + + + + Assigns the specified formula string to a cell. + + A string that is a formula contained in the cell. + + + + Assigns the rich formatted text to a cell. + + An object that is a combination of specifically formatted text regions. + + + + Creates the shared formula based on the formula contained in the host cell. + + An structure that determines a cell which contains the host formula. + + + + Assigns the specified formula expression to the given cell range to create a shared formula. + + An object used to specify a shared formula. + An object that is the worksheet cell range in which each cell will contain a shared formula. + + + + Assigns the specified formula string to the given cell range to create a shared formula. + + A string that is the textual expression used as a cell formula. + An object that is the worksheet cell range in which each cell will contain a shared formula. + + + + Gets or sets a cell value. + + An object. + + + + Contains information about a cell error. + + + + + Gets the description of the cell error. + + A string that represents the error description. + + + + Returns the cell error name. + + A string that represents the error name. + + + + Gets the cell error type. + + An enumeration member that specifies the error type. + + + + Returns an corresponding to the current cell error. + + An object. + + + + Represents a single column in a worksheet. + + + + + Applies the specified formatting settings to the entire column. + + An object that specifies format characteristics to be applied to column cells. + + + + Gets the zero-based index of the current column. + + An integer specifying the position of the column in the worksheet. + + + + Gets or sets format characteristics of the column. + + An object that specifies format characteristics applied to column cells. + + + + Gets or sets a value indicating whether the group related to this summary column is collapsed. + + true, if the group is collapsed; otherwise, false. + + + + Gets or sets whether the column is visible or hidden. + + true, if the column is hidden; otherwise, false. + + + + Gets or sets the column width in characters of the default font specified by the Normal style. + + A value that is the number of characters that can be accommodated into the column width when the column is formatted with the Normal style. + + + + Gets or sets the column width in pixels. + + An integer value that is the column width in pixels. -1 sets the default column width. + + + + Represents an interface that exposes the specific functionality of a workbook. + + + + + Creates a new worksheet in the workbook and returns the object. + + An object that is the newly created worksheet. + + + + Provides access to options that contain information about document culture and format specifications. + + An object containing document options. + + + + Provides access to the document properties associated with a workbook. + + An object containing information about a workbook. + + + + Changes the position of the specified worksheet within a workbook. + + A value specifying the name of the worksheet to be moved. + A zero-based integer that is the position at which the worksheet should be inserted. + + + + Gets or sets the theme to be applied to the workbook. + + An enumeration member specifying the document theme. + + + + Provides access to the view options of the workbook. + + An object that contains view options. + + + + Contains options related to culture-specific settings of a workbook and document format specifications and limits. + + + + + Provides access to the culture-specific settings of the document. + + A object that specifies the culture settings currently being used. + + + + Gets the file format to which the document is exported. + + An enumeration value that specifies the document format. + + + + Gets the maximum number of columns supported by the output file format. + + An value that is the maximum number of columns. + + + + Gets the maximum number of rows supported by the output file format. + + An value that is the maximum number of rows. + + + + Gets a value indicating whether the document can contain multiple worksheets. + + true, if document can contain multiple worksheets; otherwise, false. + + + + Gets a value indicating whether the document can contain formulas. + + true, if document can contain formulas; otherwise, false. + + + + Gets a value indicating whether the document supports grouping functionality. + + true, if the grouping functionality is supported by the document; otherwise, false. + + + + Represents an exporter used to create a spreadsheet document and export it to a stream. + + + + + Creates a password-protected document using the specified encryption options. + + The System.IO.Stream object to output the document to. + An object containing encryption settings. + An object that is the newly created encrypted workbook. + + + + Creates a new document and writes it to the specified stream. + + The System.IO.Stream object to output the document to. + An object that is the newly created workbook. + + + + A collection of objects. + + + + + Adds a new filter column to the worksheet collection of filters. + + An object that should be added to the collection. + + + + Removes all columns from the collection. + + + + + Determines whether the collection contains the specified item. + + An object to search for. + true, if the collection contains the specified item; otherwise, false. + + + + Returns the object by its index in the filtered range. + + An integer that is the zero-based index of the required column in the filtered range. + An object with the specified index. + + + + Returns the index of the specified column in the collection. + + An object to locate in the collection. + A zero-based integer which specifies the column position within the collection. -1 if the column doesn’t belong to the collection. + + + + Provides access to a filtered column by its index in the collection. + + An integer that is the zero-based index of the column to be obtained. + An object which represents the filtered column at the specified position. + + + + Removes the specified column from the collection. + + An object to be removed from the collection. + + + + Removes the column at the specified index from the collection. + + A zero-based integer specifying the index of the column to be removed. It should be non-negative and less than the number of elements in the collection. + + + + A base interface for classes that specify the filter criteria applied to worksheet and table columns. + + + + + Gets the type of the filter applied to a column of a table or filtered range. + + An enumeration member which indicates the filter type. + + + + An internal representation of an expression. Used to set the cell formula. + + + + + Converts an internal formula representation to a string. + + A object that specifies culture settings on which function names and numeric formatting depend. + A string that is the textual formula. + + + + Represents a collection of merged cells in a worksheet. + + + + + Merges cells in the specified cell range and appends the resulting merged range to the end of the collection. + + A object that specifies a range of cells to be merged. + true, to check whether the specified cell range to be merged intersects other merged cells; otherwise, false. + + + + Merges cells in the specified cell range and appends the resulting merged range to the end of the collection. + + A object that specifies a range of cells to be merged. + + + + Removes all merged cells from the collection. + + + + + Determines whether the collection contains the specified merged cell. + + A object associated with the merged cell to locate in the collection. + true, if the specified cell range is merged and belongs to the collection; otherwise, false. + + + + Returns the index of the specified merged cell in the collection. + + A object associated with the merged cell to locate in the collection. + A zero-based integer which specifies the merged cell’s position within the collection. -1 if the specified cell range doesn’t belong to the collection of merged cells. + + + + Provides access to the merged cell by its index in the collection. + + A zero-based integer specifying the merged cell’s position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + A object associated with the merged cell. + + + + Removes the specified merged cell from the collection. + + A object associated with the merged cell to be removed. + + + + Removes the merged cell at the specified index from the collection. + + A zero-based integer specifying the index of the merged cell to be removed. It should be non-negative and less than the number of elements in the collection. + + + + Contains options used to specify the summary rows and columns location. + + + + + Gets or sets a value indicating whether the summary rows are located below detail rows + + true, if summary rows are below each group of detail rows; otherwise, false. + + + + Gets or sets a value indicating whether the summary columns are located to the right of detail columns. + + true, if summary columns are to the right of each group of detail columns; otherwise, false. + + + + A collection of page breaks in a worksheet. + + + + + Inserts a page break at the specified position. + + A positive integer that is the index of a row or column after which a page break should be inserted.This value should start from 1 and cannot exceed 1,048,575 for rows or 16,383 for columns. + + + + Removes all page breaks from the collection. + + + + + Determines whether the collection contains a page break at the specified position (after the specified row or column). + + A positive integer that is the index of a row or a column starting from 1 and not exceeding 1,048,575 for rows or 16,383 for columns. + true, if the collection contains a page break at the specified position; otherwise, false. + + + + Returns the index of the specified page break in the collection. + + An integer that is the row or column index after which the page break to be found is inserted. + A zero-based integer which specifies the page break’s position within the collection. -1 if the page break doesn’t belong to the collection. + + + + Gets the position of the specified page break by its index in the collection. + + A zero-based integer specifying the desired page break’s position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + A positive integer that is the index of the row or column after which the page break is inserted. + + + + Removes the page break at the specified row or column index. + + An integer that is the row or column index after which the page break is inserted. + + + + Removes a page break at the specified index from the collection. + + A zero-based integer specifying the index of the page break to be removed. It should be non-negative and less than the number of elements in the collection. + + + + Represents a picture embedded in a worksheet. + + + + + Gets or sets the positioning and resizing behavior of a picture which is anchored to two cells in a worksheet. + + One of the enumeration values. + + + + Gets or sets the anchoring type used to position a picture within a worksheet. + + One of the enumeration values. + + + + Gets or sets the anchor for the bottom-right corner of a picture. + + An object that specifies the anchor cell for a picture and optional offsets from the top and left edges of this cell. + + + + Gets or sets the format of a picture. + + An enumeration value that indicates the picture format. + + + + Gets of sets the image to be displayed. + + The target image. Use the DXImage.FromBase64String or DXImage.FromStream method to load the image. + + + + Fits an object in the specified cell. + + An XlCellPosition object that specifies the position of the cell where the picture should be located. + A value that is the width of the cell into which the picture fits. + A value that is the height of the cell into which the picture fits. + A value specifying whether the picture should be center-aligned in the cell. + + + + Gets a hyperlink associated with the current object. + + An object that is a hyperlink associated with a picture in a worksheet. + + + + Gets or sets the name of the picture. + + A value that is the picture’s name. + + + + Anchors an object to an absolute position in a worksheet. + + A value that specifies the distance from the left edge of the worksheet in pixels. + A value that specifies the distance from the top edge of the worksheet in pixels. + A value that is the desired width of the picture in pixels. + A value that is the desired height of the picture in pixels. + + + + Specifies the image to be displayed in the worksheet. + + The target image. Use the DXImage.FromBase64String or DXImage.FromStream method to load the image. + The image format. + + + + Anchors an object to a specific cell in a worksheet. + + An object that specifies the anchor cell for the top-left corner of the picture and optional offsets from the top and left edges of this cell. + A value that is the desired width of the picture in pixels. + A value that is the desired height of the picture in pixels. + + + + Anchors an object to two cells in a worksheet. + + An object that specifies the anchor cell for the top-left corner of the picture and optional offsets from the top and left edges of this cell. This value is assigned to the IXlPicture.TopLeft property. + An object that specifies the anchor cell for the bottom-right corner of the picture and optional offsets from the top and left edges of this cell. This value is assigned to the IXlPicture.BottomRight property. + An enumeration value that specifies the positioning and resizing behavior of the picture. This value is assigned to the IXlPicture.AnchorBehavior property. + + + + Gets or sets the portion of the picture to draw. + + An object that specifies the source rectangle’s offsets from the corresponding edges of the picture’s bounding box. + + + + Stretches an object to fill the specified cell. + + An XlCellPosition object that specifies the position of the cell where the picture should be located. + + + + Gets or sets the anchor for the top-left corner of a picture. + + An object that specifies the anchor cell for a picture and optional offsets from the top and left edges of this cell. + + + + Represents a single row in a worksheet. + + + + + Applies the specified formatting settings to the entire row. + + An object that specifies format characteristics to be applied to row cells. + + + + Starts generating a table in the worksheet. + + A list of the objects containing the unique names of table columns and their formatting settings. + A value indicating whether the header row is displayed for the table. + An object that specifies format settings for the header row of the table. + An object representing the generated table. + + + + Starts generating a table in the worksheet. + + A list of string values representing the unique captions for table columns. + A value indicating whether the header row is displayed for the table. + An object that specifies format settings for the header row of the table. + An object representing the generated table. + + + + Starts generating a table in the worksheet. + + A list of string values representing the unique captions for table columns. + A value indicating whether the header row is displayed for the table. + An object representing the generated table. + + + + Creates the specified number of empty cells to which specific formatting options are applied. + + A positive integer that specifies the number of blank cells to be created. + An object that specifies formatting settings to be applied to the created cells. If formatting is null, a System.ArgumentNullException exception occurs. + + + + Creates cells with the specified values and format characteristics. + + An object exposing the System.Collections.IEnumerable interface that provides values for cells to be created.If the values parameter is null, a System.ArgumentNullException exception occurs. + An object that specifies formatting settings be applied to the created cells. If null, no special formatting is applied. + + + + Creates a new cell in the row and returns the object. + + An object that is the newly created cell. + + + + Creates a new cell at the intersection of the current row and the specified column. + + An integer specifying the zero-based index of the column where the created cell should be located. + An object that is the newly created cell. + + + + Finishes table generation after calling the IXlRow.BeginTable method. + + An object that is the generated table. + A value indicating whether the total row is displayed for the table. + + + + Gets or sets format characteristics of the row. + + An object that specifies format characteristics applied to row cells. + + + + Gets or sets the row height in pixels. + + An integer value that is the row height in pixels. -1 sets the default row height. + + + + Gets or sets the row height in points. + + A value that is the row height in points. + + + + Gets or sets a value indicating whether the group related to this summary row is collapsed. + + true, if the group is collapsed; otherwise, false. + + + + Gets or sets whether the row is visible or hidden. + + true, if the row is hidden; otherwise, false. + + + + Gets the zero-based index of the current row. + + An integer specifying the position of the row in the worksheet. + + + + Specifies the number of successive cells to be skipped in the row before starting to create a new cell. + + A positive integer value that specifies the number of cells in the row to be skipped. + + + + Represents a worksheet in a workbook. + + + + + Provides access to the collection of column filters. + + An collection containing columns to which the filter criteria is applied. + + + + Gets or sets the cell range for which filtering is enabled. + + An object specifying a cell range for which the AutoFilter functionality is enabled. + + + + Starts filtering data in the specified cell range. + + An object that is the header row of the cell range to be filtered. + + + + Starts creating a new group in the worksheet. + + true, to collapse the group; otherwise, false. + An integer value specifying the outline level of the created group. + + + + Starts creating a new group in the worksheet. + + An integer value specifying the group’s outline level. This value must be between 1 and 7. + true, to collapse the group; otherwise, false. + An integer value that is the current outline level of the created group. + + + + Provides access to the collection of column page breaks in a worksheet. + + An object exposing the interface. + + + + Returns the cell range that contains all custom columns manually generated in the worksheet. + + An object that encompasses all columns manually generated in the worksheet. + + + + Provides access to the collection of conditional formatting rules in a worksheet. + + A collection of objects which specify worksheet ranges and conditional formatting rules applied to them. + + + + Creates a new column in the worksheet and returns the object. + + An object that is the newly created column. + + + + Creates a new column in the worksheet with the specified index. + + An integer specifying the zero-based index of the created column. If it is negative or exceeds the last available index, an exception is raised. + An object that is the newly created column. + + + + Creates a picture to be inserted into the worksheet. + + The inserted picture. + + + + Creates a new row in the worksheet and returns the object. + + An object that is the newly created row. + + + + Creates a new row in the worksheet with the specified index. + + An integer specifying the zero-based index of the created row. If it is negative or exceeds the last available index, an exception is raised. + An object that is the newly created row. + + + + Gets the index of the column where the document exporter is currently positioned. + + A zero-based integer value that specifies the column index. + + + + Gets the outline level of the currently generated group. + + A zero-based integer that is the outline level of the current group. + + + + Gets the index of the row where the document exporter is currently positioned. + + A zero-based integer value that specifies the row index. + + + + Gets the cell range that encompasses all cells containing data. + + An object containing all nonempty cells in a worksheet. + + + + Provides access to the collection of data validation rules specified in a worksheet. + + A collection of objects that specify data validation rules applied to cell ranges. + + + + Finishes filtering data in the cell range after calling the IXlSheet.BeginFiltering method. + + + + + Finalizes the group creation after calling the IXlSheet.BeginGroup method. + + + + + Provides access to options which determine the worksheet header and footer characteristics. + + An object containing options specific to headers and footers. + + + + Provides access to the collection of hyperlinks contained in a worksheet. + + A collection of objects contained in worksheet cells. + + + + Gets or sets the type of a formula error to be skipped in the worksheet data range. + + An enumeration value that specifies the error type to be ignored. + + + + Provides access to the collection of merged cells in a worksheet. + + An object that stores all merged cells in a worksheet. + + + + Gets or sets the name of the worksheet. + + A value which specifies the worksheet name. + + + + Provides access to the group settings that control the summary row and column location. + + An object that specifies the grouping direction. + + + + Gets or sets page margins used to align the worksheet content on a printed page. + + An object that controls the worksheet’s margin settings. + + + + Gets or sets the page layout and printing options for a worksheet. + + An object that contains page formatting options. + + + + Gets or sets the cell range to be printed. + + An object that specifies an area on the worksheet to be printed. + + + + Gets or sets specific options that control how a worksheet is printed. + + An object that contains worksheet print options. + + + + Provides access to an object used to specify rows and columns to be repeated on every printed page. + + An object that specifies titles to be repeated on every printed page. + + + + Provides access to the collection of row page breaks in a worksheet. + + An object exposing the interface. + + + + Provides access to an object that allows you specify the cell selection. + + Specifies a selection and an active cell in a worksheet. + + + + Specifies the number of successive columns to be skipped in the worksheet before starting to generate a new column. + + A positive integer value that specifies the number of columns to be skipped. + + + + Specifies the number of successive rows to be skipped in the worksheet before starting to generate a new row. + + A positive integer value that specifies the number of rows to be skipped. + + + + Provides access to a collection of sparkline groups in a worksheet. + + A collection of objects contained in a worksheet. + + + + Freezes a specific number of rows and columns above and to the left of the specified cell. + + An object specifying the position of a cell below the rows and to the right of the columns that should be frozen. + + + + Provides access to the read-only collection of tables contained in the worksheet. + + An object specifying the worksheet’s collection of tables. + + + + Provides access to an object that specifies display settings for a worksheet. + + An object that contains worksheet display options. + + + + Gets or sets whether the current worksheet is visible, hidden or “very hidden”. + + An enumeration member that specifies the worksheet visibility type + + + + Defines the cell selection within a worksheet. + + + + + Gets or sets an active cell in a worksheet. + + Specifies an active cell’s position in a worksheet. + + + + Returns cell ranges selected in a worksheet. + + A list of selected ranges. + + + + Provides access to a set of display options for a worksheet. + + + + + Gets or sets a value indicating whether the worksheet is displayed from right to left. + + true, to display the worksheet from right to left; otherwise, false. + + + + Gets or sets whether to display the formula in each cell instead of the formula result. + + true, to display formulas; otherwise, false. + + + + Gets or sets whether worksheet gridlines are visible. + + true, to display worksheet gridlines; otherwise, false. + + + + Gets or sets whether outline symbols are visible on the worksheet that contains outlined data. + + true, to display outline symbols; otherwise, false. + + + + Gets or sets whether row and column headers are visible on the worksheet. + + true, to display row and column headers; otherwise, false. + + + + Gets or sets whether to display zero values in worksheet cells. + + true, to display zero values; otherwise, false. + + + + Represents a table in a worksheet. + + + + + Provides access to the read-only collection of table columns. + + An object specifying the table’s collection of columns. + + + + Gets or sets a string that provides additional information about the table. + + A value that specifies a comment associated with the table. + + + + Gets or sets format characteristics for the data area of the table. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the table’s data area. + + + + Returns a reference to the specified part of the table bounded by the specified columns. + + An enumeration member that specifies the part of the table to use in the reference. + A string that is the name of the column specifying the left bound of the referenced table range. + A string that is the name of the column specifying the right bound of the referenced table range. + An object that specifies the created reference. + + + + Returns a reference to the specified part of the table column. + + An enumeration member that specifies the part of the table column to use in the reference. + A string that is the name of the column to the specified portion of which the structured reference should refer. + An object that specifies the created reference. + + + + Returns a reference to the specified part of the table. + + An enumeration member specifying the part of the table to which the structured reference should refer. + An object that specifies the created reference. + + + + Returns a reference to the portion of the current row bounded by the specified columns. + + A string that is the name of the column specifying the leftmost cell in the referenced row. + A string that is the name of the column specifying the rightmost cell in the referenced row. + An object that specifies the created reference. + + + + Gets a reference to the cell at the intersection of the current row and the specified table column. + + A string that is the name of the column containing a value to which the structured reference should refer. + An object that specifies the created reference. + + + + Gets or sets a value indicating whether the filtering functionality is enabled for the table. + + true, to enable filtering for the table; otherwise, false. + + + + Gets a value indicating whether the header row is displayed for the table. + + true, if the table has the visible header row; otherwise, false. + + + + Gets a value indicating whether the total row is displayed at the end of the table. + + true, if the table total row is visible; otherwise, false. + + + + Gets or sets the table name. + + A value that specifies the name of the table. + + + + Gets the range of cells occupied by the table. + + An IXlCellRange object specifying the cell range that contains the table. + + + + Provides access to the table style options. + + An object that controls style settings for the table. + + + + Gets or sets border settings for a table. + + An XlDifferentialFormatting instance that specifies border formatting applied to the table’s borders. + + + + Gets or sets format characteristics for the total row of the table. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the table’s total row. + + + + A read-only collection of tables contained in a worksheet. + + + + + Represents a single column in a table. + + + + + Gets or sets format characteristics for the data area of the table column. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the column’s data area. + + + + Gets or sets the filter criteria that should be applied to the table column. + + An object implementing the interface. + + + + Gets or set a value indicating whether the AutoFilter button for the specified table column should be hidden. + + true, to hide the button; otherwise, false. + + + + Gets the unique name of the table column. + + A value that specifies the table column name. + + + + Specifies the formula to apply to all cells in the table column. + + An object exposing the interface that specifies a formula contained in the cells of the table column. + + + + Specifies the formula to apply to all cells in the table column. + + An object that is a collection of formula tokens (aka PTGs, “parsed things”) arranged in Reverse-Polish Notation order. + + + + Specifies the formula to apply to all cells in the table column. + + A string that specifies a formula contained in the cells of the table column. + + + + Gets or sets format characteristics for the total row cell of the table column. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the column’s total cell. + + + + Gets or sets the function to calculate the total of the table column. + + The enumeration member. + + + + Gets or sets the text displayed in the total cell of the table column. + + A value that specifies the text contained in the total cell of the table column. + + + + A collection of columns in a table. + + + + + Returns the index of the specified column in the collection. + + A value that specifies the name of the column to locate in the collection. + A zero-based integer specifying the position of the column in the table. -1 if the column doesn’t belong to the table. + + + + Contains table style settings. + + + + + Gets or sets the name of the built-in style applied to a table. + + A string specifying the built-in table style name. + + + + Gets or sets a value indicating whether alternate shading should be applied to the table columns. + + true, to apply striped column formatting to the table; otherwise, false. + + + + Gets or sets a value indicating whether special formatting should be applied to the first column of the table. + + true, to apply special formatting to the first column of the table; otherwise, false. + + + + Gets or sets a value indicating whether special formatting should be applied to the last column of the table. + + true, to apply special formatting to the last column of the table; otherwise, false. + + + + Gets or sets a value indicating whether alternate shading should be applied to the table rows. + + true, to apply striped row formatting to the table; otherwise, false. + + + + Represents an anchor point used to position a picture in a worksheet. + + + + + Initializes a new instance of the class with the specified settings. + + An integer that is the zero-based index of the column containing the anchor cell for a picture. + An integer that is the zero-based index of the row containing the anchor cell for a picture. + An integer value that is the column offset within the anchor cell in pixels. + An integer value that is the row offset within the anchor cell in pixels. + + + + Initializes a new instance of the class with the specified settings. + + An integer that is the zero-based index of the column containing the anchor cell for a picture. + An integer that is the zero-based index of the row containing the anchor cell for a picture. + + + + Gets the index of the column that contains the anchor cell. + + An integer value specifying the zero-based index of the column. + + + + Gets the horizontal offset from the left edge of the anchor cell to the actual position of the anchor point. + + An integer value that is the column offset within the anchor cell in pixels. + + + + Determines whether the specified object is equal to this XlAnchorPoint instance. + + An XlAnchorPoint instance to compare with the current object. + true if two objects are equal; otherwise, false. + + + + Determines whether the specified object is equal to the current instance. + + An object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets the index of the row that contains the anchor cell. + + An integer value specifying the zero-based index of the row. + + + + Gets the vertical offset from the top edge of the anchor cell to the actual position of the anchor point. + + An integer value that is the row offset within the anchor cell in pixels. + + + + Lists anchoring types used to position an object in a worksheet or specifies how a picture should be moved and resized when a two cell anchoring is used. + + + + + Absolute Anchoring. The picture does not move or resize with the underlying cells. + + + + + One Cell Anchoring. The picture moves with the anchor cell, but its size remains the same. + + + + + Two Cell Anchoring. The picture moves and/or resizes with the underlying cells as specified by the IXlPicture.AnchorBehavior property. + + + + + Provides access to the line characteristics of a cell border. + + + + + Initializes a new instance of the class with the default settings. + + + + + Returns the object that specifies all outside borders of a cell. + This method is equivalent to the XlBorder.OutlineBorders method and is reserved for future use. + + An object that defines the line color of borders. + An enumeration member that specifies the line style of borders. + An class instance. + + + + Returns the object that specifies all outside borders of a cell. + + This method is equivalent to the XlBorder.OutlineBorders method and is reserved for future use. + + An object that defines the line color of borders. + An class instance. + + + + Gets or sets the line color of the cell’s bottom border. + + An object that specifies the border line color. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Gets or sets the line color of the cell’s diagonal borders. + + A object that specifies the border line color. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Gets or sets the line color of the horizontal inner borders of a cell range. + + An object that specifies the border line color. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Specifies all inside borders of a cell range. + + An object that defines the line color of borders. + An enumeration member that specifies the line style of borders. + An class instance. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Specifies all inside borders of a cell range. + + An object that defines the line color of borders. + An class instance. + + + + Gets or sets the line color of the cell’s left border. + + An object that specifies the border line color. + + + + Returns the object specifying that a cell has no visible borders. + + An class instance. + + + + Returns the object that specifies the outside borders of a cell. + + An object that defines the line color of borders. + An enumeration member that specifies the line style of borders. + An class instance. + + + + Returns the object that specifies the outside borders of a cell. + + An object that defines the line color of borders. + An class instance. + + + + Gets or sets the line color of the cell’s right border. + + An object that specifies the border line color. + + + + Gets or sets the line color of the cell’s top border. + + An object that specifies the border line color. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Gets or sets the line color of the vertical inner borders of a cell range. + + An object that specifies the border line color. + + + + Lists values used to specify the line styles for cell borders. + + + + + Specifies the thin dash-dotted border line. + + + + + + Specifies the thin dash-dot-dotted border line. + + + + + + Specifies the thin dashed border line. + + + + + + Specifies the thin dotted border line. + + + + + + Specifies the double border line. + + + + + + Specifies the hair border line. + + + + + + Specifies the medium solid border line. + + + + + + Specifies the medium dash-dotted border line. + + + + + + Specifies the medium dash-dot-dotted border line. + + + + + + Specifies the medium dashed border line. + + + + + + Specifies that a border is not painted. + + + + + Specifies the medium slanted dash-dotted border line. + + + + + + Specifies the thick solid border line. + + + + + + Specifies the thin solid border line. + + + + + + Serves as a base for the class and specifies the border line style options. + + + + + Gets or sets the line style of the cell’s bottom border. + + An enumeration member that specifies the line style of a border. + + + + Copies the appropriate properties of the specified object into the current object of the type. + + An object that represents the object from which the settings will be copied. + + + + Gets or sets a value indicating whether the downward diagonal border should be displayed in a cell. + + true, to display a downward diagonal border; otherwise, false. + + + + Gets or sets the line style of the cell’s downward diagonal border. + + An enumeration member that specifies the line style of a border. + + + + Gets or sets the line style of the cell’s diagonal borders. + + An enumeration member that specifies the line style of borders. + + + + Gets or sets a value indicating whether the upward diagonal border should be displayed in a cell. + + true, to display an upward diagonal border; otherwise, false. + + + + Gets or sets the line style of the cell’s upward diagonal border. + + An enumeration member that specifies the line style of a border. + + + + Determines whether the specified object is equal to the current object. + + The object to compare with the current object. + true, if the specified object is equal to the current object; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Gets or sets the line style for the horizontal inner borders of a cell range. + + An enumeration member that specifies the border line style. + + + + Gets or sets the line style of the cell’s left border. + + An enumeration member that specifies the line style of a border. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + Gets or sets a value indicating whether the left, right, top and bottom borders should be applied only to the outside borders of a cell range. + + The default is true. + + + + Gets or sets the line style of the cell’s right border. + + An enumeration member that specifies the line style of a border. + + + + Gets or sets the line style of the cell’s top border. + + An enumeration member that specifies the line style of a border. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Gets or sets the line style for the vertical inner borders of a cell range. + + An enumeration member that specifies the border line style. + + + + Lists built-in styles similar to Excel’s built-in table styles. + + + + + No table style is specified. + + + + + + Lists calendar types used to interpret filter values defined by the instances. + + + + + Specifies the Hijri (Arabic Lunar) calendar. + + + + + Specifies the localized version of the Gregorian calendar. + + + + + Specifies the Arabic version of the Gregorian calendar. + + + + + Specifies the Middle East French version of the Gregorian calendar. + + + + + Specifies the transliterated English version of the Gregorian calendar. + + + + + Specifies the transliterated French version of the Gregorian calendar. + + + + + Specifies the U.S. English version of the Gregorian calendar. + + + + + Specifies the Hebrew (Lunar) calendar. + + + + + Specifies the Japanese Emperor Era calendar. + + + + + Specifies the Korean Tangun Era calendar. + + + + + The calendar type is not specified. + + + + + Specifies the Taiwan Era calendar. + + + + + Specifies the Thai calendar. + + + + + Contains alignment settings for a cell. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Creates the object using the specified horizontal and vertical alignment settings. + + An enumeration member specifying how cell data should be horizontally aligned. + An enumeration member specifying how cell data should be vertically aligned. + An class instance. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets or sets the horizontal alignment of the cell content. + + An enumeration member specifying how cell data should be horizontally aligned. + + + + Gets or sets the cell content indention from the cell edge depending on the applied horizontal alignment. + + An unsigned integer that specifies a space between the cell content and cell edge. An indent increment is equal to three spaces of the Normal style font. + + + + Gets or sets a value indicating whether the justified or distributed alignment should be applied to the last line of the cell text. + + true, to distribute the last line of the text in a cell; otherwise, false. The default is false. + + + + Gets or sets the reading order for text in a cell. + + One of the enumeration members that specifies the reading order. + + + + Reserved for future use. + + Gets or sets the additional indent value to add some extra space between the cell content and the cell edge. + + An integer value that specifies the relative indent for text in a cell. + + + + Gets or sets a value indicating whether the font size of the cell text should be automatically adjusted to fit the cell width. + + true, if the cell text size should be shrunk; otherwise, false. + + + + Gets or sets the rotation angle of the cell content. + + An integer value that specifies the rotation angle of the cell content (in degrees). The value must be between 0 and 180; 255 changes text orientation to vertical. If a value is outside the allowable range of values, the System.ArgumentException will be thrown. + + + + Gets or sets the vertical alignment of the cell content. + + An enumeration member specifying how cell data should be vertically aligned. + + + + Gets or sets a value indicating whether the text contained in a cell should be wrapped into multiple lines. + + true, if the cell text should be line-wrapped; otherwise, false. + + + + Lists values used to specify the type of cell errors. + + + + + The formula includes division by zero or by a cell that does not contain any data. This error is indicated as #DIV/0!. + + + + + The formula includes text that is not recognized (for example, a function name that is spelled incorrectly, a cell range reference without colon, etc.). This error is indicated as #NAME?. + + + + + The value is not available to the formula or function. This error is indicated as #N/A. + + + + + The specified intersection includes two ranges that do not intersect. This error is indicated as #NULL!. + + + + + The formula or function includes invalid numeric values. This error is indicated as #NUM!. + + + + + The formula includes an invalid cell reference. This error is indicated as #REF!. + + + + + The formula includes a value of the wrong data type. This error is indicated as #VALUE!. + + + + + Represents the object that specifies cell format characteristics. + + + + + Initializes a new instance of the class with the default settings. + + + + + Returns the object that provides format characteristics corresponding to the Bad MS Excel style. + + An object that specifies format options corresponding to the Bad style. + + + + Returns the object that provides format characteristics corresponding to the Calculation MS Excel style. + + An object that specifies format options corresponding to the Calculation style. + + + + Returns the object that provides format characteristics corresponding to the Check Cell MS Excel style. + + An object that specifies format options corresponding to the Check Cell style. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Determines whether the specified instances of the class are considered equal. + + An object that is the first object to compare. + An object that is the second object to compare. + true, if the objects are considered equal; otherwise false. If both first and second objects are null, the method returns true. + + + + Returns the object that provides format characteristics corresponding to the Explanatory… MS Excel style. + + An object that specifies format options corresponding to the Explanatory… style. + + + + Specifies a number format for cell values based on the given .NET-style format string. + + A value that represents the format pattern. + true, if the formatString parameter is a date and time format specifier; otherwise, false. + An object that specifies the number format options to be applied to a cell. + + + + Returns the object that provides format characteristics corresponding to the Good MS Excel style. + + An object that specifies format options corresponding to the Good style. + + + + Returns the object that provides format characteristics corresponding to the Heading 1 MS Excel style. + + An object that specifies format options corresponding to the Heading 1 style. + + + + Returns the object that provides format characteristics corresponding to the Heading 2 MS Excel style. + + An object that specifies format options corresponding to the Heading 2 style. + + + + Returns the object that provides format characteristics corresponding to the Heading 3 MS Excel style. + + An object that specifies format options corresponding to the Heading 3 style. + + + + Returns the object that provides format characteristics corresponding to the Heading 4 MS Excel style. + + An object that specifies format options corresponding to the Heading 4 style. + + + + Returns the object that provides format characteristics corresponding to the Hyperlink MS Excel style. + + An object that specifies format options corresponding to the Hyperlink style. + + + + Returns the object that provides format characteristics corresponding to the Input MS Excel style. + + An object that specifies format options corresponding to the Input style. + + + + Returns the object that provides format characteristics corresponding to the Linked Cell MS Excel style. + + An object that specifies format options corresponding to the Linked Cell style. + + + + Combines formatting settings of the target and source instances of the class. + + An object that is the target object for merging. + An object that is the source object for merging. + An object that is a result of the merge operation. + + + + Combines the format settings of the specified object with the current instance of the class. + + An object that specifies the object to combine with the current instance. + + + + Combines the format settings of the specified XlDifferentialFormatting object with the current instance of the class. + + An XlDifferentialFormatting object that specifies the object to combine with the current instance. + + + + Returns the object that provides format characteristics corresponding to the Neutral MS Excel style. + + An object that specifies format options corresponding to the Neutral style. + + + + Returns the object that provides format characteristics corresponding to the Note MS Excel style. + + An object that specifies format options corresponding to the Note style. + + + + Returns the object that provides format characteristics corresponding to the Output MS Excel style. + + An object that specifies format options corresponding to the Output style. + + + + Creates the object that specifies themed formatting for a cell. + + An enumeration member that is one of the six Accent colors used to fill the cell background. If the themeColor is other than any of the theme accent colors, the System.ArgumentException occurs. + A value from -1 to 1 used to darken (negative values) or lighten (positive values) the original theme color. If a value is outside the allowable range of values, the System.ArgumentOutOfRangeException will be thrown. + An class instance that contains theme formatting settings. + + + + Returns the object that provides format characteristics corresponding to the Title MS Excel style. + + An object that specifies format options corresponding to the Title style. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Converts the current cell format to the differential formatting object. + + An XlDifferentialFormatting object that specifies the incremental formatting to be appled. + + + + Returns the object that provides format characteristics corresponding to the Total MS Excel style. + + An object that specifies format options corresponding to the Total style. + + + + Returns the object that provides format characteristics corresponding to the Warning Text MS Excel style. + + An object that specifies format options corresponding to the Warning Text style. + + + + Defines the column, row and the reference type (relative or absolute). + + + + + Initializes a new instance of the class with the specified column and row indexes and reference type. + + An integer that is the zero-based column index. + An integer that is the zero-based row index. + A enumeration member that specifies the column reference type. + A enumeration member that specifies the row reference type. + + + + Initializes a new instance of the class with the specified column and row indexes. + + An integer that is the zero-based column index. + An integer that is the zero-based row index. + + + + Returns a new instance transformed into absolute reference. + + An object with absolute reference. + + + + Returns a new instance transformed into relative reference. + + An object with relative reference. + + + + Gets the index of a column in the position. + + An integer that is the zero-based column index. + + + + Gets the reference type of the column in the position. + + An enumeration member that is the column reference type. + + + + Determines whether the specified object is equal to this XlCellPosition instance. + + An XlCellPosition instance to compare with the current object. + true if two objects are equal; otherwise, false. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + True if the specified object is equal to the current instance; otherwise false. + + + + Gets a numerical value that is used to identify an object during equality testing. + + An integer value that is the hash code for the current object. + + + + A static method to get a special instance that denotes an invalid position. + + An structure with special property values to identify an invalid position. + + + + Gets whether both the column and the row are absolute references. + + True, if the position has the absolute column reference and the absolute row reference; otherwise, false. + + + + Gets whether the position refers to the entire column. + + True, if the position refers to the entire column; otherwise, false. + + + + Gets whether the position refers to the entire column or the entire row. + + True if the position refers to the entire row or the entire column; otherwise, false. + + + + Gets whether both the column and the row are relative references. + + True if the position has the relative column reference and the relative row reference; otherwise, false. + + + + Gets whether the position refers to the entire row. + + True if the position refers to the entire row; otherwise, false. + + + + Gets whether the instance denotes a valid position. + + True if the position is valid; otherwise, false. + + + + Gets the maximum number of columns. + + An integer that is the maximum number of columns; at the moment it is 16384. + + + + Gets the maximum number of rows. + + An integer that is the maximum number of rows; at the moment it is 1048576. + + + + Gets the index of a row in the position. + + An integer that is the zero-based row index. + + + + Gets the reference type of the row in the position. + + An enumeration member that is the row reference type. + + + + Returns the top left position in a worksheet which is the point of reference for cell coordinates. + + An that is the origin of cell positions. + + + + Constructs a textual cell reference from the position. + + A string that is the textual cell reference. + + + + Defines a range of cells. + + + + + Initializes a new instance of the class with the specified top left and bottom right positions. + + A structure which defines the top left cell of the range. + A structure which defines the bottom right cell of the range. + + + + Initializes a new instance of the class which defines a single cell. + + A structure which defines the cell position. + + + + Initializes a new instance of the class with the specified worksheet, top left and bottom right positions. + + A string that is the name of a worksheet. + A structure which defines the top left cell of the range. + A structure which defines the bottom right cell of the range. + + + + Returns a new instance transformed into absolute reference. + + A object with absolute references. + + + + Returns a new instance transformed into relative reference. + + A object with relative references. + + + + Gets or sets the position which specifies the bottom right cell in the range. + + An structure which defines a cell. + + + + Returns a range that is a continuous interval of entire columns referenced using the specified reference type. + + An integer that is the zero-based index of the leftmost column. + An integer that is the zero-based index of the rightmost column. + A enumeration member that specifies the reference type. + A object that references the column interval. + + + + Returns a range that is a continuous interval of entire columns. + + An integer that is the zero-based index of the leftmost column. + An integer that is the zero-based index of the rightmost column. + A object that references the column interval. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + True if the specified object is equal to the current instance; otherwise false. + + + + Returns a object by the indexes of the bounding rows and columns. + + An integer that is the zero-based index of the left column. + An integer that is the zero-based index of the top row. + An integer that is the zero-based index of the right column. + An integer that is the zero-based index of the bottom row. + A object that defines a worksheet range. + + + + Gets a numerical value that is used to identify an object during equality testing. + + An integer value that is the hash code for the current object. + + + + Returns a object by its reference string in the in the A1 reference style. + + A string that specifies the cell range reference in the A1 reference style. + A object created for the specified reference. + + + + Returns a range that is a continuous interval of entire rows referenced using the specified reference type. + + An integer that is the zero-based index of the top row. + An integer that is the zero-based index of the bottom row. + A enumeration member that specifies the reference type. + A object that references the row interval. + + + + Returns a range that is a continuous interval of entire rows referenced using the specified reference type. + + An integer that is the zero-based index of the top row. + An integer that is the zero-based index of the bottom row. + A object that references the row interval. + + + + Gets or sets the name of the worksheet that owns the range. + + A string that is the worksheet name. + + + + Gets or sets the position which specifies the top left cell in the range. + + An structure which defines a cell. + + + + Get a string reference to the range defined by the object. + + A string that is the reference to the worksheet range in A1 style. If a worksheet name is present (the XlCellRange.SheetName is not null), it is included in the reference. + + + + Get a string reference to the range defined by the object. + + True, to get single cell reference displayed as an interval; otherwise, false. + A string that is the reference to the worksheet range in A1 style. If a worksheet name is present (the XlCellRange.SheetName is not null), it is included in the reference. + + + + Get a string reference to the range defined by the object. + + A object providing culture-specific information. + A string that is the reference to the worksheet range in A1 style. + + + + Represents a color used in the spreadsheet document. + + + + + Gets an object whose XlColor.ColorType value is XlColorType.Auto. + + An object that represents an automatic color. + + + + Gets the indexed color value. Only used for backwards compatibility. + + An integer value that is a zero-based color index. + + + + Gets the type of the current color. + + One of the enumeration values specifying the color type. + + + + Returns the object that represents the default background color with the color index 65. + + An object that is the default background color. + + + + Returns the object that represents the default foreground color with the color index 64. + + An object that is the default foreground color. + + + + Gets an object whose XlColor.ColorType value is XlColorType.Empty. + + An object that represents an empty color. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Creates the object from the specified 8-bit color values (red, green, and blue). + + An 8-bit integer that specifies the red component value for the new color. Valid values are 0 through 255. + An 8-bit integer that specifies the green component value for the new color. Valid values are 0 through 255. + An 8-bit integer that specifies the blue component value for the new color. Valid values are 0 through 255. + An class instance. + + + + Creates the object from a 32-bit ARGB value. + + A value specifying the 32-bit ARGB value. + An class instance. + + + + Creates the object from the theme color using the specified saturation value. + + An enumeration member that is one of 12 base colors used by the current document theme. + A value from -1 to 1. If a value is outside the allowable range of values, the ArgumentOutOfRangeException will be thrown. + An class instance. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets a value indicating whether the current color is automatic or empty. + + true, if the color is automatic or empty; otherwise, false. + + + + Gets a value indicating whether the current color is empty. + + true, if the color is empty; otherwise, false. + + + + Gets an ARGB value of the current color. + + A object that represents an ARGB color. + + + + Gets the theme color based on which the object is created. + + An enumeration member that is one of 12 base colors used by the current document theme. + + + + Gets the tint value applied to the theme color. + + A value from -1 to 1. + + + + Converts the object to a human-readable string. + + A value that consists of the theme color and the tint value if the is created from a theme color by using the XlColor.FromTheme method; otherwise a string that consists of the ARGB component values. + + + + A filter by cell fill or font color. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the color to filter by. + + An value that specifies the color used by the filter criteria. + + + + Gets or sets whether to use the cell’s fill or font color in the filter criteria. + + true, to filter by the fill color; otherwise, false.The default is true. + + + + Returns the XlFilterType.Color value that is the current filter’s type. + + An XlFilterType.Color value. + + + + Gets or sets the pattern color used in the filter criteria. + + An object that specifies the foreground color of the pattern fill used as a filter criterion. + + + + Gets or sets the type of the pattern used in the filter criteria. + + An enumeration member that specifies the type of the pattern fill used as a filter criterion. + + + + Lists values used to specify the color type. + + + + + Specifies an automatic color. + + + + + Specifies an empty color. + + + + + Specifies an indexed color. + + + + + Specifies an ARGB (alpha, red, green, blue) color. + + + + + Specifies a theme-based color. + + + + + Lists values used to specify how comments anchored to worksheet cells are printed. + + + + + Cell comments are printed as they are displayed on a worksheet. + + + + + Cell comments are printed in a separate page at the end of a worksheet printout. + + + + + Cell comments are not printed. + + + + + Lists the types of format operators used in the “Above or Below Average…” conditional formatting rule. + + + + + Formats cells whose values are above the average value in a range of cells. + + + + + Formats cells whose values are above or equal to the average value in a range of cells. + + + + + Formats cells whose values are below the average value in a range of cells. + + + + + Formats cells whose values are below or equal to the average value in a range of cells. + + + + + List values that specify the axis position between negative and positive bars when the data bar conditional formatting is applied. + + + + + Displays the axis at a variable position based on negative and positive values. + + + + + Displays the axis at the midpoint of the cell. + + + + + No axis is displayed. Negative and positive bars are displayed in the same direction. + + + + + Lists types of the color scale for the color scale conditional formatting rule. + + + + + A two-color scale. + + + + + A three-color scale. + + + + + Provides access to the particular icon in the custom icon set. + + + + + Initializes a new instance of the class with the specified settings. + + The zero-based integer that is the desired icon’s position within the icon set. + One of the enumeration values specifying the type of the icon set. + + + + Returns the icon set to which the specified icon belongs. + + A object that defines the built-in icon sets. + + + + Returns the index of the particular icon in the icon set. + + An integer that is the desired icon’s position within the icon set. + + + + Lists values that sets the icon set type for the icon set conditional format. + + + + + Specifies the 3 arrows icon set. + + + + + + + Specifies the 4 arrows icon set. + + + + + + Specifies the 5 arrows icon set. + + + + + + Specifies the 3 gray arrows icon set. + + + + + + Specifies the 4 gray arrows icon set. + + + + + + Specifies the 5 gray arrows icon set. + + + + + + Specifies the 5 boxes icon set. + + + + + + Specifies the 3 flags icon set. + + + + + + Icon set type is not specified. + + + + + Specifies the 5 quarters icon set. + + + + + + Specifies the 4 ratings icon set. + + + + + + Specifies the 5 ratings icon set. + + + + + + Specifies the 4 "red to black" icon set. + + + + + + Specifies the 3 signs icon set. + + + + + + Specifies the 3 stars icon set. + + + + + + Specifies the 3 symbols icon set. + + + + + + Specifies the 3 symbols (circled) icon set. + + + + + + Specifies the 3 traffic lights icon set. + + + + + + Specifies the 3 traffic lights (rimmed) icon set. + + + + + + Specifies the 4 traffic lights icon set. + + + + + + Specifies the 3 triangles icon set. + + + + + + Lists the types of relational operators used in the conditional formatting rule. + + + + + Format cells that begin with the specified text string. + + + + + Format cells that are between two specified values. + + + + + Format cells that contains the specified text string. + + + + + Format cells that end with the specified text string. + + + + + Format cells whose values are equal to a specified value. + + + + + Format cells whose values are greater than a specified value. + + + + + Format cells whose values are greater than or equal to a specified value. + + + + + Format cells whose values are less than a specified value. + + + + + Format cell whose values are less than or equal to a specified value. + + + + + Formats cells that are not between two specified values. + + + + + Format cells that do not contain the specified text string. + + + + + Format cells whose values are not equal to a specified value. + + + + + Base class for the conditional formatting rules. + + + + + Specifies the priority of the conditional formatting rule. + + A positive integer that is the precedence of the conditional formatting rule. + + + + Gets the type of the specified conditional formatting rule. + + One of the enumeration values indicating the type of the conditional formatting rule. + + + + Gets or sets whether the conditional formatting rules with lower priority can be applied. + + true, to prevent applying conditional formatting rules with a lower priority; otherwise, false. + + + + Represents the “Above or Below Average…” conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the type of the conditional format operator used in the “Above or Below Average…” conditional formatting rule. + + One of the enumeration values representing the operator type. + + + + Gets or sets the number of standard deviations included above or below the average in the “Above or Below ASverage…” conditional formatting rule. + + An integer value that is the number of standard deviations. + + + + Represents the conditional formatting rule that highlights blank/non-blank cells. + + + + + Initializes a new instance of the class with the specified settings. + + true, to use the created formatting rule to highlight blank cells; otherwise, false. + + + + Represents the conditional formatting rule that uses the relational operator. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the type of relational operator used in a conditional formatting rule. + + One of the enumeration values representing the operator type. + + + + Gets or sets the second threshold value in the conditional formatting rule. + + A DevExpress.Export.Xl.XlValueObject object that is the second value. + + + + Gets or sets the threshold value in the conditional formatting rule. + + A DevExpress.Export.Xl.XlValueObject object representing the threshold value. + + + + Represents the Color Scale conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the type of the color scale used in the current conditional formatting rule. + + One of the enumeration values. + + + + Gets or sets the color for a cell with the maximum value. + + A object that is the color of a cell with the maximum value. + + + + Provides access the maximum threshold value of the color scale formatting rule. + + A object that is the maximum threshold value. + + + + Gets or sets the color corresponding to the cell with the midpoint value. + + A object that is the color for the cell with the midpoint value. + + + + Provides access to the midpoint threshold value of the color scale formatting rule. + + A value that is the midpoint value. + + + + Gets or sets the color corresponding to a cell with the minimum value. + + A object that is the color. + + + + Provides access to the minimum threshold value of the color scale formatting rule. + + A object that is the minimum threshold. + + + + Represents the Data Bar conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the color of the axis between positive and negative bars. + + A object that is the data bar axis color. + + + + Gets or sets the axis position in a cell. + + One of the enumeration values. + + + + Gets or sets the color of the data bar borders. + + A object that is the data bar borders color. + + + + Gets or sets the direction of data bars. + + One of the enumerator values. + + + + Gets or sets the data bar fill color. + + A object that is the data bar fill color. + + + + Gets or sets whether to apply the gradient fill type. + + true to use the gradient fill type; otherwise, false. + + + + Gets or sets the maximum length of the data bar. + + A object that is the length of the longest data bar. This length is calculated as a percentage of the column width, thus the value must be a whole number between 0 and 100. The default value is 90. + + + + Provides access to the maximum value within the cells range to which the data bat formatting rule is applied. + + A object that is the maximum value. + + + + Gets or sets the minimum length of the data bar. + + A object that is the length of the smallest data bar. This length is calculated as a fixed percentage of the column width, thus the value must be a whole number between 0 and 100. The default value is 10. + + + + Provides access to the minimum value within the cell range to which the data bar conditional formatting rule is applied. + + A object that is the minimum value. + + + + Gets or sets the border color of a negative data bar. + + A object that is the data bar border color. + + + + Gets or sets the color of a negative data bar. + + A object that is the negative data bar color. + + + + Gets or sets whether to display cell values to which the data bar conditional formatting rule is applied. + + true, to show values; otherwise, false. + + + + Represents the conditional formatting rule for cells with duplicate values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents the conditional formatting rule that uses a relational operator to determine which cells to format. + + + + + Initializes a new instance of the class with the specified settings. + + An object representing the expression used in the conditional formatting rule. + + + + Initializes a new instance of the class with the specified settings. + + A string value representing the formula used in the current formatting rule. + + + + Gets the expression used in the conditional formatting rule. + + A object that is the expression. + + + + Gets the formula used in the conditional formatting rule. + + A that is the target formula. + + + + Represents the Icon Set conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the collection of custom icons used in the conditional formatting rule. + + A IList<> object representing the list of the custom icons. + + + + Gets or sets the type of the icon set used in the current formatting rule. + + One of the enumeration values representing the icon set type. + + + + Indicates whether the custom icon set is specified. + + true to use the custom icon style; otherwise, false. The default value is false. + + + + Gets or sets whether the thresholds indicate percentile values instead of number values. + + true, to consider values percentile; otherwise, false. + + + + Gets or sets whether the icons in the icon set used in the conditional formatting rule are shown in reverse order. + + true, to show icons in reverse order; otherwise, false. + + + + Gets or sets whether to show values in the cells satisfying the format condition. + + true, to show cell values; otherwise, false. + + + + Gets the list of threshold values used in the icon set conditional formatting rule. + + A IList<> object representing the list of threshold values. + + + + Represents “A Text That Contains…” conditional formatting rule. + + + + + Initializes a new instance of the class with the specified settings. + + One of the enumeration values representing the type of the operator used in the current formatting rule. + A String value that is the value to determine. + + + + Gets or sets the text used as a formatting criterion in the conditional formatting rule. + + A that is the target text. + + + + Represents the “Date Occurring…” conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the time period used as a formatting criterion used in the “date occurring…” conditional formatting rule. + + One of the enumeration values indicating the time period. + + + + Represents the “Top/Bottom N” conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether to identify bottom cell values within the cell range. + + true, to apply formatting to the cell values falling in the bottom N bracket; otherwise, false. + + + + Gets or sets whether the thresholds indicate percentile values instead of number values. + + true, if the thresholds indicate percentile values; otherwise, false. + + + + Gets or sets the rank value used in the conditional formatting rule. + + A object representing the rank value. + + + + Represents the conditional formatting rule for cells with unique values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides formatting settings for the conditional formatting rules. + + + + + Provides access to a set of formatting properties applied to cells when the status of the conditional formatting rule is true. + + A DevExpress.Export.Xl.XlDifferentialFormatting object representing the available formatting properties. + + + + List values specifying the type of the conditional format operator in a conditional formatting rule. + + + + + Format cells that begin with the specified text string. + + + + + Format cells that contain the specified text string. + + + + + Format cell that end with the specified text string. + + + + + Format cells that do not contain the specified text string. + + + + + Lists applicable time periods in a “date occurring…” conditional formatting rule. + + + + + A date in the last seven days. + + + + + A date occurring last month. + + + + + A date occurring last week. + + + + + A date occurring next month. + + + + + A date occurring next week. + + + + + A date occurring this month. + + + + + A date occurring this week. + + + + + Today’s date. + + + + + Tomorrow’s date. + + + + + Yesterday’s date. + + + + + Lists the types of the conditional formatting operators used in the conditional formatting rule. + + + + + Format cells whose values are above or below the average for all values in the range. + + + + + Format cells that begin with the specified text string. + + + + + Format a cell using the relational operator. + + + + + Format cells using color scales. + + + + + Format blank or empty cells. + + + + + Format cells that contain errors. + + + + + Format cells that contain the specified text string. + + + + + Format cells using data bars. + + + + + Format cells with duplicate values. + + + + + Format cells that end with the specified text string. + + + + + Format cells using an expression. + + + + + Format cells using icon set. + + + + + Format non-empty cells. + + + + + Format cells that do not contain errors. + + + + + Format cells that do not contain the specified text string. + + + + + Format cells that contain dates in the specified time period. + + + + + Format cells values that fall in the top/bottom N bracket. + + + + + Format cells that contains unique values. + + + + + Represents a minimum or maximum threshold for a conditional formatting rule. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value indicating whether the “greater than or equal to” comparison operator is used by the threshold value of the icon set conditional formatting rule to determine to which cells the icon should be applied. + + true, to use the “greater than or equal to” comparison operator with the current threshold value; otherwise, false. If false, the “greater than” comparison operator is used. + + + + Gets or sets the type of the threshold value specified in the conditional formatting rule. + + One of the enumeration values. + + + + Gets or sets the threshold value specified in the conditional formatting rule. + + A DevExpress.Export.Xl.XlValueObject object that represents the threshold value. + + + + Lists values the specify the type of the threshold value to be used in conditional formatting rules + + + + + For the data bar conditional formatting rule only. Indicates that the minimum threshold value is automatically set to zero or the minimum value in the range of cells, whichever is smaller. + + + + + For the data bar conditional formatting rule only. Indicates that the maximum threshold value is automatically set to zero or the maximum value in the range of cells, which ever is larger. + + + + + Indicates that a formula is used to specify the threshold value for the conditional formatting rule. + + + + + Indicates that the highest value in the range is used to specify the maximum threshold value for the conditional formatting rule. + + + + + Indicates that the lowest value in the range is used to specify the minimum threshold value for the conditional formatting rule. + + + + + Indicates that a number value is used to specify the threshold value for the conditional formatting rule. + + + + + Indicates that a percent value is used to specify the threshold value for the conditional formatting rule. + + + + + Indicates that a percentile value is used to specify the threshold value for the conditional formatting rule. + + + + + Represents the worksheet ranges and conditional formatting rules applied to them. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the collection of ranges to which the conditional formating rule is applied. + + A IList<> object that is the ranges collection. + + + + Provides access to the collection of conditional formatting rules contained in the current instance. + + A IList<> object representing the rules collection. + + + + Specifies a criterion value and comparison operator for a custom filter. + + + + + Initializes a new instance of the class with the specified settings. + + An enumeration member that specifies the comparison operator used to construct the filter expression. This value is assigned to the XlCustomFilterCriteria.FilterOperator property. + An object that specifies the filter criterion value. This value is assigned to the XlCustomFilterCriteria.Value property. + + + + Gets or sets the comparison operator to use with the custom filter value. + + An enumeration member specifying the comparison operator used to construct the custom filter expression. + + + + Gets or sets the custom filter criteria value. + + An object that specifies the filter value. + + + + A custom filter that uses filter values and comparison operators to construct the filter expression. + + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the first filter criterion. This value is assigned to the XlCustomFilters.First property. + An object that specifies the second filter criterion. This value is assigned to the XlCustomFilters.Second property. + A value indicating whether the logical operator "AND" should be used to combine two filter criteria. If false, the "OR" operator is used. This value is assigned to the XlCustomFilters.And property. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the first filter criterion. This value is assigned to the XlCustomFilters.First property. + An object that specifies the second filter criterion. This value is assigned to the XlCustomFilters.Second property. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the filter criterion. This value is assigned to the XlCustomFilters.First property. + + + + Gets or sets a value indicating whether the logical AND operator should be used to combine two filter criteria. + + true, to use the AND operator; otherwise, false. If false, the OR operator is used. + + + + Returns the XlFilterType.Custom value that is the current filter’s type. + + An XlFilterType.Custom value. + + + + Gets or sets the first filter criterion. + + An object that specifies the filter criterion value and the comparison operator used to construct the filter expression. + + + + Gets or sets the second filter criterion. + + An object that specifies the filter criterion value and the comparison operator used to construct the filter expression. + + + + Represents the value of a custom document property. + + + + + Returns a boolean value assigned to a custom document property. + + A value that is the custom property value. + + + + Returns the date and time value assigned to a custom document property. + + A value that is the custom property value. + + + + Returns an empty custom property value. + + + + + Returns a numeric value assigned to a custom document property. + + A value that is the custom property value. + + + + Returns a string assigned to a custom document property. + + A value that is the custom property value. + + + + Gets the type of data assigned to a custom document property. + + One of the enumeration values. + + + + Lists values that specify the direction of data bars when the data bar conditional format is applied. + + + + + Specifies the direction based on the current locale. + + + + + Specifies the left-to-right direction. + + + + + Specifies the right-to-left direction. + + + + + Represents the data validation rule defined for a current worksheet. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether the data validation treats empty or blank entries as valid. + + true, to define empty cells as valid; otherwise, false. + + + + Gets or sets the value used in the criterion for data validation. + + A DevExpress.Export.Xl.XlValueObject object. + + + + Gets or sets the value used in the criterion for data validation. + + A DevExpress.Export.Xl.XlValueObject object. + + + + Gets or sets the error message to display when the entered data is not valid. + + A text for the error message. + + + + Gets or sets the style or the alert dialog window used to show the error message. + + One of the enumeration values representing the alert dialog style. + + + + Gets or sets the caption of the error alert window. + + A that is the caption text. + + + + Gets or sets the input method editor (IME) mode used by the data validation. + + One of the enumeration values + + + + Gets or sets the text for the input prompt message. + + A that is the message text. + + + + Gets or sets the lists of cell ranges whose values should be used as the data validation criteria. + + A object representing cell ranges list. + + + + Provides access to the list of values used in the data validation rule. + + A IList<> object that is the list of values. + + + + Gets or sets the relational operator used in the data validation rule. + + A enumeration values that specifies the relational operator. + + + + Gets or sets the title bar text of the prompt message. + + A that is the title text. + + + + Provides access to the collection of cell ranges to which the data validation rule is applied. + + A IList<> object representing the list of cell ranges. + + + + Gets or sets whether to display the dropdown combo box for the XlDataValidationType.List validation rule. + + true, to display a dropdown combo box; otherwise, false. + + + + Gets or sets whether to show the error message when the user input is not valid. + + true, to show the error message; otherwise, false. + + + + Gets or sets whether to show the input message. + + true, to show the message prompt; otherwise, false. + + + + Gets or sets the type of data validation. + + One of the enumeration values that specifies the data validation type. + + + + Lists the styles of the data validation error alerts. + + + + + The dialog displays the Information icon; the end-user can click OK to accept the invalid value or Cancel to reject it. + + + + + The dialog displays the Stop icon; the only options are Retry or Cancel; end-users are not allowed to enter invalid data in the cell. + + + + + The dialog displays the Warning icon; the end-user can decide whether to allow entry of the invalid data, to retry, or to remove the invalid entry. + + + + + Lists values that specify how the input method editor (IME) is controlled by data validation. + + + + + The IME control is disabled when the cell is selected. + + + + + The IME control is full width alphanumeric input mode when the cell is selected. + + + + + The IME control is full width with Hangul input mode when the cell is selected. Applies only when Korean language supports has been installed and selected. + + + + + The IME control is full width Katakana input mode when the cell is selected. Applies only when Japanese language support has been installed and selected. + + + + + The IME control is in half width alphanumeric input mode when the cell is selected. + + + + + The IME control is in half width Hangul input mode when the cell is selected. Applies only when Korean language support has been installed and selected. + + + + + The IME control is in half width Katakana input mode when the cell is selected. Applies only when Japanese language support has been installed and selected. + + + + + The IME control is in Hiragana input mode when the cell is selected. Applies only when Japanese language support has been installed and selected. + + + + + Data Validation does not control the IME mode. + + + + + The IME control is off (does not start) when the cell is selected. + + + + + The IME control starts when the cell is selected. + + + + + Lists the types of operators that can be used in certain data validation types. + + + + + Checks whether the cell value falls within a specified range of values. + + + + + Checks whether the cell value equals a specified value. + + + + + Checks whether the cell value is greater than a specified value. + + + + + Checks whether the cell value is greater than or equal to a specified value. + + + + + Checks whether the cell value is less than a specified value. + + + + + Checks whether the cell values is less than or equal to a specified value. + + + + + Checks whether the cell value does not fall with a specified range of values. + + + + + Checks whether the cell value is not equal to a specified value. + + + + + Lists the types of data validation. + + + + + The data is validated by an arbitrary formula. + + + + + Checks for date values conforming the given condition. + + + + + Checks for decimal values conforming the given condition. + + + + + Checks the values that matches the list or certain values. + + + + + No value conforms the validation criteria. + + + + + Checks text values which lengths conforms the given condition. + + + + + Checks for time values conforming the given condition + + + + + Checks for whole numeric values conforming the given condition. + + + + + A group of dates or times used in the filter criteria. + + + + + Initializes a new instance of the class with the specified settings. + + A value which is used to specify a filter criteria according to the grouping type. + A enumeration member that specifies what part of the DateTime value is used in the criteria. + + + + Gets which part of the DateTime value is used in the filter criteria. + + An enumeration member. + + + + Returns the base date or time value used to construct the filter criteria. + + A object. + + + + Lists grouping types used to specify the filter criteria for DateTime values. + + + + + Groups the values by day. + + + + + Groups the values by hour. + + + + + Groups the values by minute. + + + + + Groups the values by month. + + + + + Groups the values by second. + + + + + Groups the values by year. + + + + + Lists values used to specify how empty cells are displayed on a sparkline. + + + + + Empty cells are not plotted resulting in gaps on a chart. + + + + + Empty cells are plotted as interpolated using a line which connects data points (for the Line type of a sparkline). + + + + + Empty cells are plotted as zero values. + + + + + Contains custom document properties associated with a workbook. + + + + + Initializes a new instance of the class with the default settings. + + + + + Removes all the custom document properties from a workbook. + + + + + Returns the number of custom document properties associated with a workbook. + + An integer value that specifies the number of custom properties defined in a workbook. + + + + Gets or sets the specified custom document property by its name. + + A string that specifies the name of the custom property to be set or obtained. + An object that is the value of the custom property. + + + + Provides access to the collection of custom property names. + + A collection of custom property names which implements the IEnumerable<> interface. + + + + Lists values used to specify the document format. + + + + + The CSV format (Comma-Separated Values) - the file format to store tabular data as plain text using commas as separators between cells. + + + + + MS Excel 97-2003 binary file format. + + + + + The OpenXML file format for the workbook (default MS Excel 2007 format). File extension - .xlsx. + + + + + Contains basic document properties associated with a workbook. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the name of the application where the document was created. + + A value that is an application name. + + + + Specifies the author of the workbook. + + A value that is an author’s name. + + + + Specifies the category of the document content. + + A value that is the category name. + + + + Specifies a company associated with the workbook. + + A value that is the company name. + + + + Specifies the date and time when the workbook was created. + + A object that represents the date and time of the document creation. + + + + Provides access to the custom document properties associated with a workbook. + + An object that stores all the custom document properties defined for a workbook. + + + + Gets or sets the description of the document content. + + A value that is the document’s description. + + + + Specifies the set of keywords to support searching and indexing. + + A value containing document keywords. + + + + Specifies the name of the manager associated with the workbook. + + A value that is the name of the manager. + + + + Specifies the security level of the document. + + One of the enumeration values. + + + + Gets or sets the subject of the document. + + A value that is the document’s subject. + + + + Gets or sets the title of the document. + + A value that is the document’s title. + + + + Gets or sets the version of the application where the document was created. + + A value that is the version number. + + + + Lists the security levels of the document. + + + + + Document is locked for annotation. + + + + + Allows free access to the document. + + + + + Workbook is enforced to be opened as read-only. + + + + + Document is recommended to be opened as read-only. + + + + + Lists values used to specify the document theme. + + + + + Theme settings are not written to a workbook. + + + + + Specifies the Office 2007 - 2010 document theme. + + + + + Specifies the Office 2013 document theme. + + + + + Contains display options for the workbook. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the index of the first visible worksheet. + + The index of the first visible worksheet. The default is 0 + + + + Specifies whether to group DateTime values in the AutoFilter menu. + + true to group dates in AutoFilter menu; otherwise, false. + + + + Gets or sets the index of the active worksheet. + + The active worksheet’s index. The default is 0. + + + + Gets or sets whether to show a horizontal scrollbar. + + true to show the horizontal scrollbar; otherwise, false. + + + + Gets or sets whether to show worksheet tabs. + + true to show worksheet tabs; otherwise, false. + + + + Gets or sets whether to show a vertical scrollbar. + + true to show the vertical scrollbar; otherwise, false. + + + + Specifies the ratio between the sheet tabs selector and horizontal scrollbar. + + The ratio value in percent. The default is 60. + + + + Specifies the height of the workbook window. The value is measured in twips. + + The workbook window’s height in twips. + + + + Specifies the width of the workbook window. The value is measured in twips. + + The workbook window’s width in twips. + + + + Specifies the X coordinate for the upper left corner of the workbook window. The value is measured in twips. + + The upper left corner’s X coordinate in twips. + + + + Specifies the Y coordinate for the upper left corner of the workbook window. The value is measured in twips. + + The upper left corner’s Y coordinate in twips. + + + + A dynamic filter that shows dates that fall within a specified time period or displays values that are above or below the average. + + + + + Initializes a new instance of the class with the specified settings. + + An enumeration member that specifies the dynamic filter type. This value is assigned to the XlDynamicFilter.DynamicFilterType property. + An object that specifies a minimum value for a dynamic filter. This value is assigned to the XlDynamicFilter.Value property. + An object that specifies a maximum value for a dynamic filter. This value is assigned to the XlDynamicFilter.MaxValue property. + + + + Initializes a new instance of the class with the specified settings. + + An enumeration member that specifies the dynamic filter type. This value is assigned to the XlDynamicFilter.DynamicFilterType property. + An object that specifies a filter value. This value is assigned to the XlDynamicFilter.Value property. + + + + Initializes a new instance of the class with the specified settings. + + An enumeration member that specifies the dynamic filter type. This value is assigned to the XlDynamicFilter.DynamicFilterType property. + + + + Gets or sets the type of the dynamic filter. + + An enumeration member that specifies the dynamic filter type. + + + + Returns the XlFilterType.Dynamic value that is the current filter’s type. + + An XlFilterType.Dynamic value. + + + + Gets or sets a maximum value for the dynamic filter. + + An object. + + + + Gets or sets a dynamic filter value. + + An object. + + + + Lists the types of dynamic filter, i.e., a filter whose results may depend on the data to which it is applied or the current date. + + + + + Shows values that are above the average value. + + + + + Shows values that are below the average value. + + + + + Shows dates occurring last month. + + + + + Shows dates occurring last quarter. + + + + + Shows dates occurring last week. + + + + + Shows dates occurring last year. + + + + + Shows dates occurring in January, regardless of the year. + + + + + Shows dates occurring in October, regardless of the year. + + + + + Shows dates occurring in November, regardless of the year. + + + + + Shows dates occurring in December, regardless of the year. + + + + + Shows dates occurring in February, regardless of the year. + + + + + Shows dates occurring in March, regardless of the year. + + + + + Shows dates occurring in April, regardless of the year. + + + + + Shows dates occurring in May, regardless of the year. + + + + + Shows dates occurring in June, regardless of the year. + + + + + Shows dates occurring in July, regardless of the year. + + + + + Shows dates occurring in August, regardless of the year. + + + + + Shows dates occurring in September, regardless of the year. + + + + + Shows dates occurring next month. + + + + + Shows dates occurring next quarter. + + + + + Shows dates occurring next week. + + + + + Shows dates occurring next year. + + + + + Shows dates occurring in the 1st quarter, regardless of the year. + + + + + Shows dates occurring in the 2nd quarter, regardless of the year. + + + + + Shows dates occurring in the 3rd quarter, regardless of the year. + + + + + Shows dates occurring in the 4th quarter, regardless of the year. + + + + + Shows dates occurring this month. + + + + + Shows dates occurring this quarter. + + + + + Shows dates occurring this week. + + + + + Shows dates occurring this year. + + + + + Shows today’s dates. + + + + + Shows tomorrow’s dates. + + + + + Shows dates occurring between the beginning of the current year and today, inclusive. + + + + + Shows yesterday’s dates. + + + + + Lists values used to specify how cell errors are printed. + + + + + Cell errors are not printed. + + + + + Cell errors are printed as double dashes (–). + + + + + Cell errors are printed as they are displayed on a worksheet. + + + + + Cell errors are printed as #N/A. + + + + + Represents an object that creates an exporter for generating spreadsheet files of the specified format. + + + + + Creates an exporter that performs data export to the specified Excel format using the specified formula parser. + + One of the enumeration members that specifies the type of the output document. + An object exposing the IXlFormulaParser interface that provides the capability to parse worksheet formulas. Required to validate worksheet formulas before export. + An object exposing the interface. + + + + Creates an exporter that performs data export to the specified Excel format. + + One of the enumeration members that specifies the type of the output document. + An object exposing the interface. + + + + An object which can be used to specify a worksheet cell formula. + + + + + Initializes a new instance of the class with the default settings. + + + + + Constructs a textual expression from the object. + + A string expression. + + + + Constructs a textual expression from the object using the specified settings. Intended for internal use. + + An DevExpress.Export.Xl.IXlExpressionContext object that contains culture-specific, reference style and other settings. + A string expression. + + + + Lists possible ways to interpret and calculate a formula in a worksheet. + + + + + Formula is calculated as an array formula in a worksheet. + + + + + The formula works with an array of values. + + + + + Formula is calculated as if it is entered in the worksheet cell in the usual way. It does not operate with arrays to return arrays. + + + + + Formula is calculated as a shared formula in a worksheet. + + + + + Contains the cell background attributes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the background color of the cell pattern fill. + + An value that specifies the background color. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets the foreground color of the cell pattern fill. + + An value that specifies the pattern color. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Returns the object specifying that a cell has no fill. + + An class instance. + + + + Creates the object that specifies the pattern fill for a cell background. + + An enumeration member that is a preset type of the cell pattern fill. + An object that specifies the background color of the pattern fill. + An object that specifies the foreground color of the pattern fill. + An object that specifies the cell background fill. + + + + Creates the object that specifies the automatic pattern fill for a cell background. + + An enumeration member that is a preset type of the cell pattern fill. + An object that specifies the cell background fill. + + + + Gets or sets the type of the pattern applied to a cell background. + + An enumeration member that is a preset type of pattern fill. + + + + Creates the object that specifies the solid fill for a cell background. + + An object that is the color used to fill a cell background. + An object that specifies the cell background fill. + + + + A column in the filter range to which filtering is applied. + + + + + Initializes a new instance of the class with the specified settings. + + A zero-based index of the column in the filtered range to which a filter should be applied. + An object implementing the interface which specifies the filter criteria to be applied to this column. + + + + Initializes a new instance of the class with the specified settings. + + A zero-based index of the column in the filtered range to which a filter should be applied. + + + + Gets the zero-based index of the current column in the filtered range. + + An integer specifying the position of the column in the filtered range. + + + + Gets or sets the filter criteria that should be applied to the current column. + + An object implementing the interface. + + + + Gets or set a value indicating whether the AutoFilter button for the specified column should be hidden. + + true, to hide the button; otherwise, false. + + + + Lists comparison operators used in a custom filter. + + + + + Filters values that are equal to a specified criterion value. + + + + + Filters values that are greater than a specified criterion value. + + + + + Filters values that are greater than or equal to a specified criterion value. + + + + + Filters values that are less than a specified criterion value. + + + + + Filters values that are less than or equal to a specified criterion value. + + + + + Filters values that are not equal to a specified criterion value. + + + + + Lists types of filters available for the AutoFilter functionality. + + + + + Specifies the filter by color. + + + + + Specifies the custom filter based on a comparison operator. + + + + + Specifies the dynamic filter. + + + + + Specifies the filter by conditional formatting icons. + + + + + Specifies the "Top 10" filter. + + + + + Specifies the filter by values and date intervals. + + + + + Contains the cell font attributes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Returns the object corresponding to the body font used in the current document theme. + + An class instance that represents the theme body font. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Gets or sets the color of the font applied to the cell content. + + An object that specifies the font color. + + + + Copies the appropriate properties of the specified object into the current instance of the class. + + An class instance representing the source object for copying. + + + + Creates the object that specifies a custom font with the given face name, size and color. + + A value that specifies the font name. + A value that specifies the font size in points. + An object that specifies the font color. + An class instance that is the custom font with specified characteristics. + + + + Creates the object that specifies a custom font with the given face name and size. + + A value that specifies the font name. + A value that specifies the font size in points. + An class instance that is the custom font with specified characteristics. + + + + Creates the object that specifies a custom font with the given face name. + + A value that specifies the font name. + An class instance that represents the custom font. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets the font family of the font applied to cell content. + + An object that specifies the font family. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Returns the object corresponding to the heading font used in the current document theme. + + An class instance that represents the theme heading font. + + + + Serves as a base for the class and specifies the common font characteristics. + + + + + Gets or sets the value indicating whether the cell content is formatted as bold. + + true, if the cell text is bold; otherwise, false. + + + + Gets or sets the basic set of characters associated with the current font. + + An integer value that represents the font character set. Valid values are 0 to 255. + + + + Compatibility setting. Gets or sets a value indicating whether the cell font is condensed. + + true, to squeeze text characters together; otherwise, false. + + + + Copies the appropriate properties of the specified object into the current object of the type. + + An object that represents the object from which the settings will be copied. + + + + Determines whether the specified object is equal to the current object. + + The object to compare with the current object. + true, if the specified object is equal to the current object; otherwise false. + + + + Compatibility setting. Gets or sets a value indicating whether the cell font is extended. + + true, to stretch the text; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets or sets the value indicating whether the cell content is formatted as italic. + + true, if the cell text is italic; otherwise, false. + + + + Gets or sets the name of the font applied to the cell content. + + A value that specifies the font name. + + + + Compatibility setting. Gets or sets the value indicating whether the cell content is formatted as an outline. + + true, to display only inner and outer borders of each character; otherwise, false. + + + + Gets or sets the font scheme for the current font. + + One of the enumeration members. + + + + Formats the cell content as subscript or superscript. + + An enumeration member indicating whether the text is subscript or superscript. + + + + Compatibility setting. Gets or sets a value indicating whether the cell font is formatted as shadowed. + + true, to add a shadow to the cell text; otherwise, false. + + + + Gets or sets the size of the font applied to the cell content. + + A value specifying the font size in points. + + + + Gets or sets the value indicating whether the cell content is formatted as strikethrough. + + true, if the strikethrough formatting is applied to the cell text; otherwise, false. + + + + Gets or sets the type of underline applied to the cell content. + + An enumeration value. + + + + Lists values used to specify the font family to which a cell font may belong. + + + + + Specifies that information about a font family of the given font does not exist. In this case, the default font family is used. + + + + + Specifies a novelty font. + + + + + Specifies a monospace font with or without serifs. + + + + + Specifies a proportional font with serifs. + + + + + Specifies a script font that is designed to mimic the appearance of handwriting. + + + + + Specifies a proportional font without serifs. + + + + + Lists values used to specify the font scheme. + + + + + Specifies the major font of the document theme. + + + + + Specifies the minor font of the document theme. + + + + + Specifies that the given font is not a theme font. + + + + + Serves as a base for the class and provides properties to change cell format settings. + + + + + Gets or sets alignment options to be applied to the cell content. + + An object that specifies cell alignment settings. + + + + Gets or sets border settings to be applied to a cell. + + An object that specifies a border style and color. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Gets or sets fill settings to be applied to the cell background. + + An object that specifies cell background characteristics. + + + + Gets or sets font settings to be applied to the cell content. + + An object that specifies cell font attributes. + + + + Gets or sets a value indicating whether the format string assigned to the XlFormatting.NetFormatString property is a date and time format string. + + true, if the .NET-style format string is used to format a date and time value in a cell; otherwise, false. + + + + Gets or sets the .NET-style format string that specifies how a numeric value should be displayed in a cell. + + A value that represents the format pattern. + + + + Gets or sets an MS Excel-style number format that specifies how a numeric value should be displayed in a cell. + + An object that specifies a cell number format. + + + + Provides static methods used to construct an internal representation of an expression (an object). + + + + + An AVERAGE statistical function. + + An array of objects interpreted as function parameters. + An object that is the function result. + + + + A COLUMN reference function + + An object that is the function result. + + + + A COLUMN reference function. + + An that is the worksheet range. + An object that is the function result. + + + + A CONCATENATE text function. + + An array of the objects which are the strings to join. + An object that is the function result. + + + + A COUNT statistical function. + + An array of objects interpreted as function parameters. + An object that is the function result. + + + + A COUNTA statistical function. + + An array of objects interpreted as function parameters. + An object that is the function result. + + + + A COUNTBLANK statistical function. + + A that specifies the range containing the cells to be counted. + An object that is the function result. + + + + An IF logical function. + + A object that is the predicate. + A object that is returned if a predicate is true. + A object that is returned if a predicate is false. + An object that is the function result. + + + + A MAX statistical function. + + An array of objects interpreted as function parameters. + An object that is the function result. + + + + A MIN statistical function. + + An array of objects interpreted as function parameters. + An object that is the function result. + + + + Creates a new object from the specified value. + + An object. However, a value of any standard type can be supplied because the class implements multiple implicit constructors. + An object that is the function result. + + + + A ROW reference function + + An object that is the function result. + + + + A ROW reference function + + An that is the worksheet range. + An object that is the function result. + + + + A SUBTOTAL mathematical function. + + A object which references the cells containing values for calculation. + A enumeration member that specifies the calculation type, i.e. the function used for calculation. + True to include hidden rows or columns in the calculation; otherwise, false. + An object that is the function result. + + + + A SUBTOTAL mathematical function. + + A list of objects which are the references to cells containing values for calculation. + A enumeration member that specifies the calculation type, i.e., the function used for calculation. + True, to include hidden rows or columns in the calculation; otherwise, false. + An object that is the function result. + + + + A SUM mathematical function. + + An array of objects which are the constants, expressions or function results to sum. + An object that is the function result. + + + + A TEXT text function. + + An object that is the function parameter. + A object that specifies the formatting applied to the function parameter. + An object that is the function result. + + + + A TEXT text function. + + An object that is the function parameter. + A .NET Framework format string. + True if the format string is the date and time format string; otherwise, false. + An object that is the function result. + + + + A TEXT text function. + + An value. However, a value of any standard type can be supplied because class implements multiple implicit constructors. + A object that specifies the formatting applied to the function parameter. + An object that is the function result. + + + + A TEXT text function. + + An object. However, a value of any standard type can be supplied because the class implements multiple implicit constructors. + A .NET Framework format string. + True if the format string is the date and time format string; otherwise, false. + An object that is the function result. + + + + A TRUNC mathematical function. + + An object that is the function parameter. + An integer that is the number of decimal places left in the truncated number. + An object that is the function result. + + + + A TRUNC mathematical function. + + An object that is the function parameter. + An object that is the function result. + + + + A VLOOKUP reference function + + An object that is the lookup value. + A object that is the reference to the range to search. + An integer that is the index of a column in the range to search from which to retrieve a value. + True means that if the function cannot find an exact match to the lookup value, it should use the closest match below the supplied value; false means that if the function cannot find an exact match, it should return an error. + An object that is the function result. + + + + A VLOOKUP reference function. + + An object that is the lookup value. However, a value of any standard type can be supplied because the class implements multiple implicit constructors. + A object that is the reference to the range to search. + An integer that is the index of a column in the range to search from which to retrieve a value. + True means that if the function cannot find an exact match to the lookup value, it should use the closest match below the supplied value; false means that if the function cannot find an exact match, it should return an error. + An object that is the function result. + + + + Represents the object that specifies headers and footers of a worksheet. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value indicating whether the header or footer edges should be aligned with page margins. + + true, to align the header or footer with page margins; otherwise, false. + + + + Turns bold on or off for the characters that follows. + + + + + Prints the name of the workbook. + + + + + Prints the workbook file path. + + + + + Centers the characters that follow. + + + + + Removes headers and footers from a worksheet. + + + + + Prints the current date. + + + + + Gets or sets a value indicating whether the first page of the worksheet has unique headers and footers. + + true, to specify a unique header or footer for the first page; otherwise, false. + + + + Gets or sets a value indicating whether the odd-numbered pages have headers and footers different from those on even-numbered pages. + + true, to specify different headers and footers for the odd-numbered and even-numbered pages; otherwise, false. + + + + Turns double underline on or off for the characters that follow. + + + + + Gets or sets the text to be displayed in the footer of even-numbered pages. + + A object that specifies the footer for even-numbered pages. + + + + Gets or sets the text to be displayed in the header of even-numbered pages. + + A object that specifies the header for even-numbered pages. + + + + Gets or sets the text to be displayed in the footer of the first worksheet page. + + A object that specifies the footer for the first page. + + + + Gets or sets the text to be displayed in the header of the first worksheet page. + + A object that specifies the header for the first page. + + + + Specifies the left-aligned, centered and right-aligned text for the header of footer. + + A System.String that specifies the text to be displayed in the left header or footer section. + A System.String that specifies the text to be displayed in the center header or footer section. + A System.String that specifies the text to be displayed in the right header or footer section. + A System.String that represents the resulting text string included in the header or footer. + + + + Turns italic on or off for the characters that follow. + + + + + Left aligns the characters that follow. + + + + + Gets or sets the text to be displayed in the footer of odd-numbered pages. + + A object that specifies the footer for odd-numbered pages. + + + + Gets or sets the text to be displayed in the header of odd-numbered pages. + + A object that specifies the header for odd-numbered pages. + + + + Prints the current page number. + + + + + Prints the total number of pages in the document. + + + + + Right aligns the characters that follow. + + + + + Gets or sets a value indicating whether headers and footers should be scaled proportionately when print scaling is used to fit information on the specified number of pages. + + true, to scale headers and footers with document scaling; otherwise, false. + + + + Prints the name of the worksheet. + + + + + Turns strikethrough on or off for the characters that follow. + + + + + Turns subscript on or off for the characters that follow. + + + + + Turns superscript on or off for the characters that follow. + + + + + Prints the current time. + + + + + Turns underline on or off for the characters that follow. + + + + + Lists values used to specify the horizontal alignment of the cell content. + + + + + The cell content is centered horizontally across the cell. + + + + + The cell content is centered horizontally across multiple cells. + + + + + The text is wrapped to fit into the cell width and each line of text is horizontally distributed across the full width of the cell. This alignment type applies an indent to both the left and right sides of the cell. + + + + + Repeats the cell content across the entire width of the cell. + + + + + The cell content is horizontally aligned according to the data type (text is aligned to the left; numbers, date and time values are aligned to the right; boolean and error values are centered). + + + + + The text is wrapped to fully fit into the cell width and each line of text (except the last line) is horizontally justified to the right and left of the cell. + + + + + The cell content is horizontally aligned to the left edge of the cell. + + + + + The cell content is horizontally aligned to the right edge of the cell. + + + + + Represents a hyperlink in a worksheet. + + + + + Initializes a new instance of the class with default settings. + + + + + Compatibility setting. Gets or sets the text to be displayed for the specified hyperlink. + + A value that specifies the display text for a hyperlink. + + + + Gets or sets the cell or cell range that contains the hyperlink. + + An object specifying the location of a hyperlink in a worksheet. + + + + Serves as the base for the and classes that define hyperlinks for cells and pictures. + + + + + Gets or sets the hyperlink destination. + + A value that specifies the destination to which a hyperlink refers. + + + + Gets or sets a text for the tooltip displayed when the mouse hovers over a hyperlink. + + A value that specifies the tooltip text for the hyperlink. + + + + Lists the types of errors which occur in cell formulas and can be skipped using the IXlSheet.IgnoreErrors property. + + + + + All errors are ignored. + + + + + The cell in a calculated column contains a formula that is different from the calculated column formula. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + The formula contains a reference to an empty cell. + + + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + The cell contains a formula that results in an error. Error values include #DIV/0!, #N/A, #NAME?, #NULL!, #NUM!, #REF!, and #VALUE!. + + + + + The formula does not match the pattern of nearby formulas. + + + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + The formula omits certain cells in a region. The rule checks whether the formula in the cell which references a cell range includes a range of cells that is adjacent to the cell that contains the formula. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + A cell value does not comply with the data validation rule restricting data to predefined items in a list. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + No errors are ignored. + + + + + Numbers stored as text or preceded by an apostrophe. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + A text date that might be misinterpreted as the wrong century. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + The cell containing a formula is not locked for protection. + + The screenshot that illustrates this error type is taken in Microsoft® Excel®. + + + + + Represents the object that specifies a cell number format. + + + + + Gets the object that uses the "d-mmm" format code to display a cell value as a date. + + An object that specifies a cell number format. + + + + Gets the format code corresponding to the current number format. + + A value that is the format string. + + + + Gets the unique identifier associated with the current number format. + + An integer value that is the number format ID. + + + + Gets the object that uses the "# ?/?" format code to display a cell number as a fraction. + + An object that specifies a cell number format. + + + + Gets the object that uses the "# ??/??" format code to display a cell number as a fraction. + + An object that specifies a cell number format. + + + + Gets the object that uses the General format to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets a value indicating whether the current is a date and time format. + + true, if the is used to format a date and time value in a cell; otherwise, false. + + + + Gets the object that uses the "d-mmm-yy" format code to display a cell value as a date. + + An object that specifies a cell number format. + + + + Gets the object that uses the "h:mm:ss AM/PM" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "h:mm:ss" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "mm:ss" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "mm:ss.0" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "mmm-yy" format code to display a cell value as a date. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0;(#,##0)" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0.00;(#,##0.00)" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0;[Red]#,##0)" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0.00;[Red]#,##0.00)" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "0" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "0.00" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "#,##0.00" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "0%" format code to display a cell number as a percentage. + + An object that specifies a cell number format. + + + + Gets the object that uses the "0.00%" format code to display a cell number as a percentage. + + An object that specifies a cell number format. + + + + Gets the object that uses the "0.00E+00" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "##0.0E+0" format code to display numeric data in a cell. + + An object that specifies a cell number format. + + + + Gets the object that uses the "mm-dd-yy" format code to display a cell value as a date. + + An object that specifies a cell number format. + + + + Gets the object that uses the "m/d/yy h:mm" format code to display a cell value as a date and time. + + An object that specifies a cell number format. + + + + Gets the object that uses the "h:mm AM/PM" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "h:mm" format code to display a cell value as a time value. + + An object that specifies a cell number format. + + + + Gets the object that uses the "[h]:mm:ss" format code to display a cell value as the total amount of time elapsed. + + An object that specifies a cell number format. + + + + Gets the object that uses the "@" character to display a cell value as a text. + + An object that specifies a cell number format. + + + + A static class that implements methods to create arithmetic and logical operations in the expression. + + + + + An arithmetic addition operator. + + An object that is the left operand. + An object that is right the operand. + An object that is the operation result. + + + + A division operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + An equality operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A “Greater than” operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A “Greater than or equal” operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A “Less than” operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A “Less than or equal” operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A multiplication operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + An inequality operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + A subtraction operator. + + An object that is the left operand. + An object that is the right operand. + An object that is the operation result. + + + + Represents the object that specifies page margins for a worksheet. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the size of the bottom margin of a printed page. + + A value that specifies the bottom margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Gets or sets the space between a footer and the bottom edge of a printed page. + + A value that specifies the footer margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Gets or sets the space between a header and the top edge of a printed page. + + A value that specifies the header margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Gets or sets the size of the left margin of a printed page. + + A value that specifies the left margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Gets or sets the unit of margin measurement. + + An enumeration value that specifies the unit of measurement for worksheet margins.The default is XlPageUnits.Inches. + + + + Gets or sets the size of the right margin of a printed page. + + A value that specifies the right margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Gets or sets the size of the top margin of a printed page. + + A value that specifies the top margin in a unit of measurement defined by the XlPageMargins.PageUnits property. + + + + Lists values used to specify the page orientation applied when a worksheet is being printed. + + + + + Worksheet page orientation is default. + + + + + Worksheet page orientation is landscape. + + + + + Worksheet page orientation is portrait. + + + + + Lists values used to specify the order in which worksheet pages are numbered and printed when the worksheet data does not fit on one page. + + + + + Worksheet pages are numbered and printed from the top down and then left to right. + + + + + Worksheet pages are numbered and printed from left to right and then from the top down. + + + + + Represents the object that specifies page formatting options. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value indicating whether the first page number should be selected automatically. + + true, to use the default page number for the first printed page; otherwise, false. + + + + Gets or sets whether to print the worksheet in black and white or in color. + + true, to print the worksheet in black and white; otherwise, false. + + + + Gets or sets how comments contained in a worksheet are printed. + + One of the enumeration values. + + + + Gets or sets the number of worksheet copies to print. + + A positive integer that is a number of copies to print.If the number of copies is less than 1 or greater than 32767, a System.ArgumentOutOfRangeException will be thrown. + + + + Gets or sets a value indicating whether the worksheet should be printed without graphics and graphic elements (such as gridlines). + + true, to exclude graphics from the printout; otherwise, false. + + + + Gets or sets how errors contained in worksheet cells are printed. + + One of the enumeration values. + + + + Gets or sets the number from which pagination starts on the current worksheet. + + An integer that is the number of the first page of the printed worksheet. + + + + Gets or sets the number of pages by height in which the worksheet should fit when printed. + + A positive integer value that specifies the number of pages that the worksheet should fit on.This value must be between 0 and 32767; otherwise, a System.ArgumentOutOfRangeException will be thrown. + + + + Gets or sets a value indicating whether the worksheet content should be scaled to fit on a specific number of pages. + + true, if the FitToPage print option is enabled; otherwise, false. + + + + Gets or sets the number of pages wide the worksheet should fit on when printed. + + A positive integer value that specifies the number of pages that the worksheet should fit on.This value must be between 0 and 32767; otherwise, a System.ArgumentOutOfRangeException will be thrown. + + + + Gets or sets the horizontal printer resolution, in dots per inch. + + A positive integer that specifies the printing resolution.The default value is 600 DPI. + + + + Gets or sets the page orientation applied when a worksheet is being printed. + + An enumeration member. + + + + Gets or sets the order in which worksheet pages are numbered and printed. + + An enumeration member. + + + + Gets or sets a value that specifies the paper size used when a worksheet is being printed. + + An enumeration value that indicates the paper size. + + + + Gets or sets the percentage by which to scale the worksheet content. + + A positive integer value that determines print scaling. This value must be between 10 and 400; otherwise, a System.ArgumentOutOfRangeException will be thrown. + + + + Gets or sets a value indicating whether to use the default page settings specified by the printer. + + true, to use the printer’s defaults settings for a printed page; otherwise, false. + + + + Gets or sets the vertical printer resolution, in dots per inch. + + A positive integer that specifies the printing resolution.The default value is 600 DPI. + + + + Lists values used to specify the units of margin measurement. + + + + + Specifies centimeters as a unit of margin measurement. + + + + + Specifies inches as a unit of margin measurement. + + + + + Lists the types of patterns available for cell shading. + + + + + Specifies a pattern that is a series of thick downward diagonal stripes. + + + + + + Specifies the 75% gray pattern. + + + + + + Specifies the thick grid pattern. + + + + + + Specifies a pattern that is a series of thick horizontal stripes. + + + + + + Specifies the thick diagonal trellis pattern. + + + + + + Specifies a pattern that is a series of thick upward diagonal stripes. + + + + + + Specifies a pattern that is a series of thick vertical stripes. + + + + + + Specifies the 6.25% gray pattern. + + + + + + Specifies the 12.5% gray pattern. + + + + + + Specifies a pattern that is a series of thin downward diagonal stripes. + + + + + + Specifies the 25% gray pattern. + + + + + + Specifies the thin grid pattern. + + + + + + Specifies a pattern that is a series of thin horizontal stripes. + + + + + + Specifies the thin diagonal trellis pattern. + + + + + + Specifies a pattern that is a series of thin upward diagonal stripes. + + + + + + Specifies a pattern that is a series of thin vertical stripes. + + + + + + Specifies the 50% gray pattern. + + + + + + No background (solid color or fill pattern) is applied to a cell. + + + + + Specifies that a cell is filled with a solid color. + + + + + Represents a hyperlink associated with a picture. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Gets a value indicating whether the hyperlink associated with a picture refers to an external resource (web page, e-mail address, file or directory) or to an internal resource (to a cell range in the current workbook). + + true, if the hyperlink refers to an external resource; otherwise, false. + + + + Gets or sets the target frame in which to display the web page when the hyperlink is clicked. + + A value representing a predefined name of the target window (frame). By default, it is an empty string. + + + + Lists reference types used to specify a cell position. + + + + + Absolute reference type. + + + + + Relative reference type. + + + + + Represents the object that specifies printing options for a worksheet. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value indicating whether worksheet gridlines should be printed. + + true, to print worksheet gridlines; otherwise, false. + + + + Gets or sets a value indicating whether row and column headings should be printed. + + true, to print row and column headings; otherwise, false. + + + + Gets or sets a value indicating whether worksheet data is centered horizontally on a printed page. + + true, to center worksheet data; otherwise, false. + + + + Gets or sets a value indicating whether worksheet data is centered vertically on a printed page. + + true, to center worksheet data; otherwise, false. + + + + Represents the object that specifies rows and columns to be repeated on every printed page. + + + + + Initializes a new instance of the class with the specified settings. + + An object that is the worksheet containing row and column titles to be printed. + + + + Gets or sets specific columns to be repeated on every printed page. + + An object that specifies worksheet columns repeated on every printed page. + + + + Gets or sets specific rows to be repeated on every printed page. + + An object that specifies worksheet rows repeated on every printed page. + + + + Sets columns to be repeated on the left side of every printed page. + + A zero-based integer representing the index of the first column to be printed on each page. + A zero-based integer representing the index of the last column to be printed on each page. + + + + Sets rows to be repeated at the top of every printed page. + + A zero-based integer representing the index of the first row to be printed on each page. + A zero-based integer representing the index of the last row to be printed on each page. + + + + Returns a string reference to a range that includes the entire rows and/or columns repeated on every printed page. + + A string reference to the title rows and/or title columns printed on every page. + + + + Lists values used to specify the reading order of the cell. + + + + + Specifies that the reading order depends on the context and is determined by the first strong character: if it is a right-to-left character, the reading order is also right-to-left; otherwise, the reading order is left-to-right. + + + + + Specifies that the reading order is left-to-right. + + + + + Specifies that the reading order is right-to-left. + + + + + Represents a region of the cell text with its own set of font characteristics. + + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the text of this cell region. This value is assigned to the XlRichTextRun.Text property. + An object that specifies font attributes to be applied to the text. If null, the default font is used. This value is assigned to the XlRichTextRun.Font property. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets the font settings of the current region of the cell text. + + An object providing members to change font attributes of the cell text region. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets or sets the text of the current cell region with a specific font. + + A value that specifies the text associated with the current cell region. + + + + Represents a rich formatted text in a cell. + + + + + Initializes a new instance of the class with the default settings. + + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value that is the hash code for the current object. + + + + Gets a value indicating whether the rich text in a cell is a plain text rather than formatted. + + true, if the rich text is empty or not formatted; otherwise, false. + + + + Provides access to the collection of cell text regions, each formatted with its own font. + + A collection of objects. + + + + Gets or sets the full rich text of a cell. + + A value that specifies the text displayed in a cell. + + + + Lists values used to format the text in a cell as superscript or subscript. + + + + + Specifies that the cell text should be located at the normal baseline and should have the same size as the surrounding text. + + + + + Specifies that the cell text should be formatted as subscript. + + + + + Specifies that the cell text should be formatted as superscript. + + + + + Lists values used to specify the worksheet visibility. + + + + + A worksheet is hidden. + + + + + A worksheet is hidden and cannot be unhidden from the user interface. + + + + + A worksheet is visible. + + + + + Specifies the portion of the picture to display in a worksheet. + + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the source rectangle’s offset from the left edge of the picture’s bounding box. + A value that specifies the source rectangle’s offset from the top edge of the picture’s bounding box. + A value that specifies the source rectangle’s offset from the right edge of the picture’s bounding box. + A value that specifies the source rectangle’s offset from the bottom edge of the picture’s bounding box. + + + + Gets the offset from the bottom edge of the bounding box. + + A value. A positive value indicates an inset and a negative value specifies an outset. + + + + Gets whether properties of the current object are set to 0. + + true, if the object’s properties have the default value 0; otherwise, false. + + + + Gets the offset from the left edge of the bounding box. + + A value. A positive value indicates an inset and a negative value specifies an outset. + + + + Gets the offset from the right edge of the bounding box. + + A value. A positive value indicates an inset and a negative value specifies an outset. + + + + Gets the offset from the top edge of the bounding box. + + A value. A positive value indicates an inset and a negative value specifies an outset. + + + + A single sparkline in the sparkline group. + + + + + Creates a single sparkline for the specified data and location. + + A object that specifies the cell range containing the source data for the sparkline. + A object that specifies the cell range where the sparkline should be located. + + + + Gets or sets the cell range that contains the source data for a single sparkline. + + A object that contains sparkline values. + + + + Gets or sets the location of an individual sparkline in a worksheet. + + A object that specifies the cell in which the sparkline is located. + + + + Lists values used to specify how to calculate the minimum and maximum values for the vertical axis of a sparkline group. + + + + + Specifies that the minimum or maximum value for the sparkline vertical axis should be set to the custom value defined by the XlSparklineGroup.ManualMin or XlSparklineGroup.ManualMax property, respectively. + + + + + Specifies that the minimum or maximum value for the sparkline vertical axis should be calculated automatically and shared across all the sparklines in the group. + + + + + Specifies that the minimum or maximum value for the sparkline vertical axis should be automatically set to the lowest or highest value calculated individually for each sparkline in the group. + + + + + A sparkline group in a worksheet. + + + + + Initializes a new instance of the class with the default settings. + + + + + Creates a line sparkline group for the specified data and location. + + A object that specifies the cell range containing the source data for the group. + A object that specifies the cell range where the sparkline group should be located. + + + + Gets or sets the color of the horizontal axis. + + An object that specifies the axis color. + + + + Gets or sets the color of the first data point for each sparkline in the sparkline group. + + An object that specifies the point color. + + + + Gets or sets the color of the highest data point for each sparkline in the sparkline group. + + An object that specifies the point color. + + + + Gets or sets the color of the last data point for each sparkline in the sparkline group. + + An object that specifies the point color. + + + + Gets or sets the color of the lowest data point for each sparkline in the sparkline group. + + An object that specifies the point color. + + + + Gets or sets the color of the data markers for each sparkline in the sparkline group. + + An object that specifies the marker color. + + + + Gets or sets the color of the negative data points for each sparkline in the sparkline group. + + An object that specifies the point color. + + + + Gets or sets the color for each sparkline in the sparkline group. + + An object that specifies the line color. + + + + Gets or sets the date range for the sparkline group. + + A object that contains the date values for the sparkline data. + + + + Gets or sets how empty cells are plotted. + + A enumeration member that specifies how blank values are displayed on a sparkline. + + + + Gets or sets whether data in hidden cells are plotted in the sparkline group. + + True to display data in hidden cells; otherwise, false. + + + + Gets or sets whether data markers are displayed for each sparkline in the sparkline group. + + True to display data markers; otherwise, false. + + + + Gets or sets whether the horizontal axis is displayed for each sparkline in the sparkline group. + + True to display the horizontal axis; otherwise, false. + + + + Gets or sets whether the first data point in the sparkline should be colored differently. + + True, to highlight the first data point; otherwise, false. + + + + Gets or sets whether the highest data point in the sparkline should be colored differently. + + True to highlight the highest data point; otherwise, false. + + + + Gets or sets whether the last data point in the sparkline should be colored differently. + + True to highlight the last data point; otherwise, false. + + + + Gets or sets whether the lowest data point in the sparkline should be colored differently. + + True to highlight the lowest data point; otherwise, false. + + + + Gets or sets whether negative data points in the sparkline should be colored differently. + + True to highlight negative data points; otherwise, false. + + + + Gets or sets the line weight for each sparkline in the sparkline group. + + A value that is the line weight measured in points. + + + + Gets or sets the maximum for the vertical axis that is the same for all sparklines in the sparkline group. + + A value that specifies the maximum value for the vertical axis. + + + + Gets or sets the minimum for the vertical axis that is the same for all sparklines in the sparkline group. + + A value that specifies the maximum value for the vertical axis. + + + + Specifies how the vertical axis maximums for the sparklines in the sparkline group are calculated. + + A enumeration member that determines how to calculate vertical axis maximums. + + + + Specifies how the vertical axis minimums for the sparklines in the sparkline group are calculated. + + A enumeration member that determines how to calculate vertical axis minimums. + + + + Gets or sets whether the data points on the horizontal axis are plotted in right-to-left order. + + True, to plot values right-to-left; otherwise, false. + + + + Provides access to the collection of sparklines contained in the sparkline group. + + A IList<> object that is a collection of sparklines. + + + + Gets or sets the type of a sparkline group. + + A enumeration member value that specifies the sparkline group type. + + + + Lists values used to specify sparkline chart types (types of sparkline groups). + + + + + Sparkline data points are plotted as vertical bars. + + + + + Sparkline data points are plotted as a line. + + + + + Sparkline data points are plotted with identically sized bars above the horizontal axis for positive values (win) and below the horizontal axis for negative values (loss), + + + + + Lists summary functions used in subtotals. + + + + + The AVERAGE statistical function. + + + + + The COUNT statistical function. + + + + + The COUNTA statistical function. + + + + + The MAX statistical function. + + + + + The MIN statistical function. + + + + + The PRODUCT mathematical function. + + + + + The STDEV.P statistical function. + + + + + The STDEV.S statistical function. + + + + + The SUM mathematical function. + + + + + The VAR.P statistical function. + + + + + The VAR.S statistical function. + + + + + Represents an object used to create a table column with custom formatting applied to its regions. + + + + + Initializes a new instance of the class with the specified settings. + + A string specifying the unique name of the table column. + + + + Gets or sets format characteristics for the data area of the table column. + + An XlDifferentialFormatting object that specifies format characteristics applied to the column’s data area. + + + + Gets or sets format characteristics for the header row cell of the table column. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the column’s header cell. + + + + Gets the unique name of the table column. + + A value that specifies the table column name. + + + + Gets or sets format characteristics for the total row cell of the table column. + + An XlDifferentialFormatting instance that specifies format characteristics applied to the column’s total cell. + + + + Lists special item specifiers used within structured references to refer to specific parts of a table or table column(s). + + + + + A special item specifier that refers to the entire table, including column headers, data, and totals (if any). + + + + + No special item specifiers are defined to restrict the portion of the table used in the structured reference. + + + + + A special item specifier that refers to the data area. + + + + + A special item specifier that refers to the header row. + + + + + A special item specifier that refers to the cells in the same row as the formula. + + + + + A special item specifier that refers to the total row. + + + + + Represents a reference to table data. + + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the referenced table. This value is assigned to the XlTableReference.Table property. + An enumeration member specifying the part of the table to which the structured reference refers. This value is assigned to the XlTableReference.Part property. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the referenced table. + A string that is the name of the column to the specified portion of which the structured reference refers. + An enumeration member that specifies the part of the table column to use in the reference. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the referenced table. This value is assigned to the XlTableReference.Table property. + A string that is the name of the column specifying the left bound of the referenced range. This value is assigned to the XlTableReference.FirstColumn property. + A string that is the name of the column specifying the right bound of the referenced range. This value is assigned to the XlTableReference.LastColumn property. + An enumeration member that specifies the part of the table to use in the reference. This value is assigned to the XlTableReference.Part property. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the referenced table. This value is assigned to the XlTableReference.Table property. + A string that is the name of the column specifying the left bound of the referenced data range. This value is assigned to the XlTableReference.FirstColumn property. + A string that is the name of the column specifying the right bound of the referenced data range. This value is assigned to the XlTableReference.LastColumn property. + + + + Initializes a new instance of the class with the specified settings. + + An object that specifies the referenced table. + A string that specifies the name of the column containing data to which the structured reference refers. + + + + Gets the name of the column used as the left bound to specify the portion of the table to be referenced. + + A string that specifies the column name. + + + + Gets the name of the column used as the right bound to specify the portion of the table to be referenced. + + A string that specifies the column name. + + + + Gets a special item specifier used by the current structured reference to refer to a specific part of the table. + + An enumeration member. + + + + Gets the table to which the current structured reference refers. + + An object that is the referenced table. + + + + Converts a table reference to a string. + + A string that specifies the textual representation of a table reference. + + + + Converts a table reference to a string. + + A object that provides culture-specific information. + A string that specifies the textual representation of a table reference. + + + + Lists the base colors of the document theme. + + + + + Specifies the Accent 1 theme color. + + + + + Specifies the Accent 2 theme color. + + + + + Specifies the Accent 3 theme color. + + + + + Specifies the Accent 4 theme color. + + + + + Specifies the Accent 5 theme color. + + + + + Specifies the Accent 6 theme color. + + + + + Specifies the Dark 1 text/background color. + + + + + Specifies the Dark 2 text/background color. + + + + + Specifies the theme color used to highlight the visited hyperlink. + + + + + Specifies the theme color used to highlight the inserted hyperlink. + + + + + Specifies the Light 1 text/background color. + + + + + Specifies the Light 2 text/background color. + + + + + Specifies that theme colors are not used to set a foreground or background color. + + + + + A Top 10 filter that displays top/bottom ranked values. + + + + + Initializes a new instance of the class with the specified settings. + + A value that is a number or percentage of column values to display. This value is assigned to the XlTop10Filter.Value property. + A value that is the actual cell value used by the filter to perform the comparison. This value is assigned to the XlTop10Filter.FilterValue property. + A value indicating whether to filter column values by top order. This value is assigned to the XlTop10Filter.Top property. + A value indicating whether to show values that fall in the top/bottom N percent of column values. This value is assigned to the XlTop10Filter.Percent property. + + + + Initializes a new instance of the class with the specified settings. + + A value that is the actual cell value used by the filter to perform the comparison. This value is assigned to the XlTop10Filter.FilterValue property. + + + + Returns the XlFilterType.Top10 value that is the current filter’s type. + + An XlFilterType.Top10 value. + + + + Gets or sets the actual cell value which is used to perform the comparison for the current filter. + + A value. + + + + Gets or sets a value indicating whether to show values that fall in the top/bottom N percent of a column. + + true, to filter by the top/bottom N percent of column items; otherwise, false. A false value filters by a number of items. + + + + Gets or sets whether top items should be included in the "Top 10" filtering results. + + true, to filter by top order; otherwise, false. If false, bottom items satisfying the filter criteria are displayed. + + + + Gets or sets a top or bottom value to use as the filter criteria. + + A value that is a number or percentage of column items to display. For example, "Filter by Top 5 Items" or "Filter by Top 10 Percent". + + + + Lists functions to calculate the totals of table columns. + + + + + Returns the average (arithmetic mean) of the numbers contained in the table column. + + + + + Returns the number of cells with non-empty values contained in the table column. + + + + + Returns the number of cells with numeric values contained in the table column. + + + + + Returns the largest number contained in the table column. + + + + + Returns the smallest number contained in the table column. + + + + + Indicates that the total for the table column is not calculated. + + + + + Calculates the standard deviation based on the sample contained in the table column. + + + + + Returns the sum of the numbers contained in the table column. + + + + + Calculates the variance of the sample contained in the table column. + + + + + Lists underline styles. + + + + + Specifies a double underline. + + + + + Specifies a double accounting underline. + + Adds a double-line underline that is displayed lower than the XlUnderlineType.Double underline and fills the entire cell width if the cell contains text or date values. + + + + + Specifies that the text is not underlined. + + + + + Specifies a single underline. + + + + + Specifies a single accounting underline. + Adds a single-line underline that is displayed lower than the XlUnderlineType.Single underline and fills the entire cell width if the cell contains text or date values. + + + + + An object that can be used to create a criterion for data validation and as a threshold value specified in the conditional formatting rule. + + + + + Converts the object’s value to Boolean and returns the result. + + A value. + + + + Converts the object’s value to type and returns the result. + + A value. + + + + Returns an empty object. + + A object specifying an empty value. + + + + Converts the object’s value to cell error type and returns the result. + + An object that contains information on a cell error. + + + + Converts the object’s value to XlExpression and returns the result. + + A value. + + + + Converts the object’s value to a worksheet formula and returns the result. + + A string that is the worksheet formula. It starts with an equal sign (=). If conversion fails, returns an empty string. + + + + Converts the specified object to a value object using the default converter. + + An object to be converted to a + A object. If the conversion cannot be performed, an InvalidCastException is thrown. + + + + Gets whether the object originates from the value of the boolean type. + + true, if the object has a boolean value; otherwise, false. + + + + Gets whether the object has an empty value. + + true, if the object has an empty value; otherwise, false. + + + + Gets whether the object contains a Cell Error value. + + true, if the parameter has a cell error value; otherwise, false. + + + + Gets whether the object contains an expression value. + + true, if the parameter has an expression value; otherwise, false. + + + + Gets whether the object contains a cell formula value. + + true, if the object contains a cell formula; otherwise, false. + + + + Gets whether the current object contains a number. + + true, if the current value is of the numeric type; otherwise, false + + + + Gets whether the object originates from a worksheet Range. + + true, if the object has a XlCellRange value; otherwise, false. + + + + Gets whether the object originates from a text string. + + true, if the object has a text value; otherwise, false. + + + + Converts the object’s value to numeric and returns the result. + + A Double value. + + + + Converts the object’s value to a worksheet range and returns the result. + + A XlCellRange object that specifies the worksheet Range. + + + + Converts the object’s value to a string and returns the result. + + A String value + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + A filter by a list of cell values or date and time values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the calendar type for date groups used in filtering. + + An enumeration member. + + + + Provides access to the collection of date and time values to filter by. + + A collection of objects specifying date and time values that should be used in a filter. + + + + Gets or sets a value indicating whether blank cells should be included in the filtering results. + + true, to filter blank cells; otherwise, false. + + + + Returns the XlFilterType.Values value that is the current filter’s type. + + An XlFilterType.Values value. + + + + Provides access to the collection of cell values to filter by. + + A collection of values to be used in a filter. + + + + A variant value that can be used as a cell value, filter value or function argument. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A value that is the base date December 30, 1899. + + + + Gets or sets the boolean value stored by the object. + + A value. + + + + Gets or sets the date and time value stored by the object. + + A value. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A object that represents the 60-day time interval. + + + + Returns the object specifying an empty value. + + + + + Determines whether the specified object is equal to this XlVariantValue object. + + An XlVariantValue object to compare with the current object. + true if two objects are equal; otherwise, false. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true, if the specified object is equal to the current instance; otherwise false. + + + + Returns the object specifying the #DIV/0! cell error. + + + + + Returns the object specifying the #VALUE! cell error. + + + + + Returns the object specifying the #NAME? cell error. + + + + + Returns the object specifying the #NULL! cell error. + + + + + Returns the object specifying the #NUM! cell error. + + + + + Returns the object specifying the #REF! cell error. + + + + + Gets or sets the cell error stored by the object. + + An object implementing the interface that contains information on a cell error. + + + + Returns the object specifying the #N/A cell error. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + The string “FALSE”. + + + + Converts the specified object to . + + An object to be converted to an . + An object that corresponds to the specified object. If the conversion cannot be performed, an empty is returned. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + Gets whether the current object contains a Boolean value. + + true, if the current value is of the Boolean type; otherwise, false + + + + Gets whether the current object has an empty value. + + true, if the current value is empty; otherwise, false. + + + + Gets whether the current object contains an error. + + true, if the current value is of the error type; otherwise, false + + + + Gets whether the current object contains a number. + + true, if the current value is of the numeric type; otherwise, false + + + + Gets whether the current object contains text. + + true, if the current value is of the text type; otherwise, false + + + + Gets or sets the number stored by the object. + + A value. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A serial value. + true, to use the 1904 date system; otherwise, false. + + + + Gets or sets the text stored by the object. + + A value. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Returns a value containing a textual representation of the object. + + An object. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + Returns a value containing a textual representation of the object. + + A object specifying the culture settings. + An object. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + The string “TRUE”. + + + + Gets the type of the object. + + An enumerator member specifying the value type. + + + + Lists values used to specify a variant value type. + + + + + A variant value contains data of the boolean type. + + + + + A variant value contains a number that is regarded as date and time. + + + + + A variant value contains data of the error type. + + + + + The value type is unknown. + + + + + A variant value contains data of the numeric type. + + + + + A variant value contains data of the text type. + + + + + Lists values used to specify the vertical alignment of the cell content. + + + + + The cell content is vertically aligned at the bottom. + + + + + The cell content is centered vertically. + + + + + The text is vertically distributed across the cell height. + + + + + The cell content is vertically justified. + + + + + The cell content is vertically aligned at the top. + + + + + Contains cell formatting settings applied when exporting a control’s data to XLS(X) format. + + + + + Initializes a new instance of the class. + + + + + Gets or sets text alignment, wrapping, rotation, best-fit and indentation options. + + Options that define how text is aligned, wrapped, rotated, best-fit and indented. + + + + Gets or sets the cell’s background color. + + The cell’s background color. + + + + Copies the font, format string and background color settings from the specified object to the current object. + + An object whose settings are copied. + A value to be assigned to the XlFormattingObject.FormatType property. + + + + Gets or sets font attributes for the currently processed cell. + + An object that contains font attributes for the currently processed cell. + + + + Gets the pattern for formatting values. + + The string representing the format pattern. + + + + Gets or sets the type of formatting applied to the current value. + + The formatting type. + + + + Gets or sets the native Excel format string used to format the currently processed value. + + A string value, representing the XLSX format string. + + + + An object that contains information on the summary calculated in the currently being processed cell. + + + + + Initializes a new instance of the class. + + + + + Specifies the display format for the summary item value. + + A string that specifies the display format. + + + + Returns a data field whose values are used to calculate the summary. + + The data field’s name. + + + + Returns the summary function type. + + The function type. + + + + A base interface that implements methods to modify the exported spreadsheet. + + + + + Adds an empty row. + + + + + Adds an empty row and populates it with values. + + An array of cell values to insert in the added row. + + + + Adds an empty row and populates it with the specified values. + + An array of cell values to insert in the added row. + + + + Inserts an image into the specified cell range. + + The image to insert. + A cell range. + + + + Merges cells in the specified range. + + An object that specifies a cell range. + + + + Implements methods which allow you to modify a header or footer in the exported spreadsheet. + + + + + Inserts a n image into the sheet’s header of footer. + + The image to insert. + The image size. + + + + Contains classes that provide printing functionality to a Report and Dashboard Server. + + + + + Provides data for the RemoteDocumentSource.AuthenticationServiceClientDemanded event. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the authentication service client. + + An object implementing the interface. + + + + Lists the values, specifying the supported user authentication types. + + + + + The remote document source is a Report and Dashboard Server that supports the Forms authentication type. + + + + + The remote document source is a Report and Dashboard Server that supports the Guest authentication type. + + + + + The remote document source is a custom WCF report service. + + + + + The remote document source is a Report and Dashboard Server that supports the Windows authentication type. + + + + + A method that will handle the RemoteDocumentSource.ReportServerCredentialsDemanded event. + + The event sender. + A object that contains data related to the event. + + + + Provides data for the RemoteDocumentSource.ReportServerCredentialsDemanded event. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified user credentials. + + A value, specifying the user name. This value is assigned to the CredentialsEventArgs.UserName property. + A value, specifying the password. This value is assigned to the CredentialsEventArgs.Password property. + + + + Specifies whether or not the RemoteDocumentSource.ReportServerCredentialsDemanded event was handled. + + true if the event was handled; otherwise, false. + + + + Specifies the user password to login to a Report and Dashboard Server. + + A value, specifying the password. + + + + Specifies the user name to login to a Report and Dashboard Server. + + A value, specifying the user name. + + + + A document that is created by a remote service (a Report and Dashboard Server or custom WCF report service). + + + + + Initializes a new instance of the class with the specified Printing System. + + A descendant. + + + + Specifies whether continuous document export can be performed. + + true, if continuous document export can be performed; otherwise, false. + + + + Releases all resources used by . + + + + + Indicates whether or not the document is empty (i.e., does it contain at least one page). + + true if the document is emtpy; otherwise, false. + + + + Gets the total number of pages within a report. + + An integer value, specifying the number of report pages. + + + + Asynchronously obtains the specified report created by a remote document source. + + An object, identifying the report. + An object implementing the interface, specifying the report parameters. + + + + For internal use. + + A object. + + + + Provides functionality to publish objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Occurs when connecting to an . + + + + + Specifies the user authentication type that is appropriate to an assigned remote document source. + + An enumeration value. + + + + Triggers the document generation. + + + + + Triggers the document generation with the specified settings. + + A object. + + + + Specifies a prefix that precedes Report and Dashboard Server endpoint configurations located in the Web.config file. + + A value. + + + + Occurs before displaying the Parameters panel in a Print Prevew. + + + + + Occurs when the parameter values are changed in the Parameters UI. + + + + + Identifies documents that are created remotely by a . + + An object, identifying a document. + + + + Specifies the name of a remotely created document. + + A value, specifying the document name. + + + + Intended to request user credentials to login to a Report and Dashboard Server. + + + + + Occurs when connecting to a report service client. + + + + + Specifies the uniform resource identifier (URI) of a remote document source. + + A value, specifying the document source URI. + + + + Renders documents that are generated by remote sources (i.e., by a report service or Report Server). + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the interface. (Typically, this is a object.) + + + + Provides data for the RemoteDocumentSource.ReportServiceClientDemanded event. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies a custom report service client. + + An object implementing the interface. + + + + Contains classes that provide additional printing functionality to a Report and Dashboard Server. + + + + + For internal use. + + + + + Prints the specified document. + + A delegate of a object. + A System.Func<TResult> delegate of a object. + + + + Prints the specified page range. + + An integer value. + An integer value. + A System.Action<string> delegate. + + + + Contains classes that provide client-side functionality to the service model of a Report and Dashboard Server. + + + + + Provides the client-side functionality for the Report and Dashboard Server authentication service. + + + + + Initializes a new instance of the class with the specified channel. + + An object implementing the interface. + + + + Logs into a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + A value, containing information about the asynchronous operation. + An action delegate containing a object that returns a Boolean value, specifying the operation result. + + + + Asynchronously logs into a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a Boolean value. + + + + Supports automatic creation on the client side. + + + + + Initializes a new instance of the class with the specified settings. + + An object, specifying the authentication service address. + An enumeration value. + + + + Initializes a new instance of the class with the specified settings. + + An object, specifying the authentication service address. + A object. + + + + Initializes a new instance of the class with the specified settings. + + A value, specifying the endpoint configuration name. + An object, specifying the authentication service address. + + + + Initializes a new instance of the class with the specified endpoint configuration name. + + A value, specifying the endpoint configuration name. + + + + Creates a . + + An object implementing the interface. + + + + An extension for sharing the Report Server authentication cookie between an and the to link them. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets a value indicating the behavior type. + + A enumeration value. + + + + Shares the Report Server authentication cookie between an and the to link them. + + + + + Initializes a new instance of the class with the default settings. + + + + + Passes data to bindings (for custom behavior support). + + A object, specifying the endpoint to modify. + A object, specifying the objects required by binding elements to support the behavior. + + + + Implements a modification or extension of the authentication service client across a contract. + + A object, specifying the endpoint. + A object, specifying the client runtime. + + + + Implements a modification or extension of the authentication service across an endpoint. + + A object, specifying the endpoint that exposes the contract. + An object, specifying the endpoint dispatcher to be modified or extended. + + + + Examines the description tree and a corresponding runtime object to ensure it conforms to some set of criteria. + + A object, specifying the endpoint. + + + + Used to detect the authentication cookie by the class. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified cookie. + + A object. + + + + Ensures that no invalid messages received from the service are relayed to the client user code. + + A reference. + A value. + + + + Ensures that no invalid messages are sent to the service. + + A reference. + An object implementing the interface. + A value. + + + + If implemented by a class, provides functionality for the DevExpress Report Server authentication service. + + + + + Logs into a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + true if the attempt to login is successful; otherwise false. + + + + If implemented by a class, provides a service contract for the . + + + + + Starts logging in to a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Ends logging in to a Report and Dashboard Server. + + An object containing information about the status of an asynchronous operation. + true if the user has been successfully logged in; otherwise false. + + + + If implemented by a class, provides the client-side functionality for the DevExpress Report Server authentication service. + + + + + Logs into a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + A value, specifying the operation state. + An action delegate containing a object that returns a Boolean value, specifying the operation result. + + + + Asynchronously logs into a Report and Dashboard Server. + + A value, specifying the user name. + A value, specifying the password. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a Boolean value. + + + + If implemented by a class, provides the client-side functionality for a DevExpress Report Server. + + + + + Creates a copy of the specified report. + + A System.Int32 value specifying a source report. + A data transfer object specifying properties of the created report copy. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Provides the controls for the context of a channel. + + An object implementing the System.ServiceModel.IContextChannel interface. + + + + Asynchronously creates a report category. + + A value, specifying the report category name. + A value, containing information about the asynchronous operation. + A , specifying the category ID. + + + + Creates a copy of the specified report. + + A System.Int32 value specifying a source report. + A data transfer object specifying properties of the created report copy. + A value, containing information about the asynchronous operation. + + + + Asynchronously creates a new report. + + A object, providing information about the report. + A value, containing information about the asynchronous operation. + A , specifying the . + + + + Creates a new report category with the specified name. + + A System.String value specifying a category name. + A value, containing information about the asynchronous operation. + A System.Action delegate to be callled when the operation is complete. + + + + Asynchronously creates a scheduled job. + + A object, specifying properties of the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying the job ID. + + + + Asynchronously deletes a report category. + + An integer value, identifying the report category. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Asynchronously deletes a data model. + + An integer value, identifying the data model. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Deletes the specified report. + + A System.Int32 specifying a report to delete. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Deletes the specified report category. + + A System.Int32 value specifying a report category to delete. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously deletes a scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Asynchronously executes a scheduled job. + + An integer value, identifying the scheduled job. + A nullable integer value. + A value, containing information about the asynchronous operation. + A , specifying the job ID. + + + + Returns a collection of items to be displayed in the categories list. + + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously returns a collection of report categories. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the data columns corresponding to a specified data member. + + A value, specifying the data source name. + A object, identifying the data member. + A value, containing information about the asynchronous operation. + + + + Asynchronously returns the data columns corresponding to a specified data member. + + A value, specifying the data source name. + A object, identifying the data member. + An asynchronous operation result, containing a collection of objects. + + + + Occurs on completion of obtaining the information about data columns from the server. + + + + + Asynchronously returns the list of data members corresponding to a specified data source. + + A value, specifying the data source name. + A value, containing information about the asynchronous operation. + + + + Asynchronously returns the list of data members corresponding to a specified data source. + + A value, specifying the data source name. + An asynchronous operation result, containing a collection of objects. + + + + Occurs on completion of obtaining the information about data members from the server. + + + + + Asynchronously gets a data model. + + An integer value, identifying the data model. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously gets a collection of data models. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the list of available data sources. + + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the list of available data sources. + + A value, containing information about the asynchronous operation. + + + + Obtains an XML schema of the specified data source. + + A System.Int32 value specifying a data source. + A value, containing information about the asynchronous operation. + A System.String containing a data source schema. + + + + Occurs on completion of obtaining the information about data sources from the server. + + + + + Gets properties of the specified report to be displayed in a report catalog. + + A System.Int32 value specifying a report. + A data transfer object containing the values of the report properties to be displayed in a report catalog. + + + + Gets a collection of revisions for the specified report. + + A System.Int32 value specifying a report. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Gets a collection of items to be displayed in a report catalog. + + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously gets a collection of reports. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns a specified scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously returns the logs corresponding to a specified scheduled job. + + An integer value, identifying the scheduled job. + A descendant, specifying how the data should be paginated. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the total number of logs corresponding to a specified scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying the total number of logs. + + + + Asynchronously returns the result of a scheduled job. + + An integer value, identifying the result of a scheduled job. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously returns the history of results corresponding to a specified scheduled job log. + + An integer value, identifying the scheduled job log. + A descendant, specifying how the data should be paginated. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the total number of results corresponding to a specified scheduled job log. + + An integer value, identifying the scheduled job log. + A value, containing information about the asynchronous operation. + A , specifying the total number of job results. + + + + Asynchronously returns all scheduled jobs. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Loads the specified report from the server storage. + + A System.Int32 specifying a report to load. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously loads a report. + + An integer value, identifying the report. + A value, containing information about the asynchronous operation. + A , specifying the . + + + + Gets the specified revision of a report layout. + + A System.Int32 value specifying a report. + A System.Int32 value specifying a report revision. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Locks the specified report. + + A System.Int32 specifying the report to lock. + + + + Checks a server for availability. + + A System.Action delegate to be called when the operation is complete. + A value, containing information about the asynchronous operation. + + + + Rolls the layout of a report back to the specified revision. + + A System.Int32 value specifying a report to roll back. + A System.Int32 value specifying a target layout revision. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Saves the specified report to the server storage. + + A System.Int32 value specifying a report to save. + A Data Transfer Object containing report data. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Unlocks the specified report. + + A System.Int32 specifying the report to unlock. + + + + Asynchronously updates a report category. + + An integer value identifying the report category. + A value specifying the report category name. + A nullable integer value specifying a category version used for optimistic locking. + A value containing information about the asynchronous operation. + A specifying an asynchronous operation. + + + + Asynchronously updates a data model. + + A object. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Updates properties of the specified report. + + A System.Int32 value specifying a report to update. + A data transfer object containing new values for report properties. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously updates an existing report. + + An integer value, identifying the report. + A object, providing information about the report. + A value, containing information about the asynchronous operation. + A , specifying the report ID. + + + + Updates the name of the specified report category. + + A System.Int32 specifying the report category to update. + A System.String value specifying a new name for the report category. + A nullable integer value specifying a category version used for optimistic locking. + A value containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously updates a scheduled job. + + A object, specifying properties of the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Uploads report layout data onto a server. + + A System.IO.Stream containing layout data. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + If implemented by a class, provides a service contract for the . + + + + + Starts creating a report copy. + + An integer value, identifying the report to clone. + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts creating a report. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts creating a report category. + + A value, specifying the report category name. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts creating a scheduled job. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts deleting a report category. + + An integer value, specifying the report category ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts deleting a data model. + + An integer value, identifying the data model. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts deleting a report. + + An integer value, specifying the report ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts deleting a scheduled job. + + An integer value, specifying the scheduled job ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Begins executing a scheduled job. + + An integer value, identifying the scheduled job. + A nullable integer value. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the report categories. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the columns from a data source. + + A value, specifying the data source name. + A object, specifying the data member. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the data members from a data source. + + A value, specifying the data source name. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the data model. + + An integer value, identifying the data model. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the available data models. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the data sources. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the report revisions. + + An integer value, specifying the report ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the reports. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the scheduled job. + + An integer value, identifying the scheduled job. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the scheduled job logs. + + An integer value, identifying the scheduled job. + A descendant, specifying how the data should be paginated. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the total number of scheduled job logs. + + An integer value, identifying the scheduled job. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the scheduled job result. + + An integer value, identifying the scheduled job result. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the history of results corresponding to a specified scheduled job log. + + An integer value, identifying the scheduled job log. + A descendant, specifying how the data should be paginated. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining the total number of results corresponding to a specified scheduled job log + + An integer value, identifying the scheduled job log. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts obtaining all scheduled job. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts loading a report. + + An integer value, specifying the report ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts loading the layout of a specific report revision. + + An integer value, specifying the report ID. + An integer value, specifying the revision ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts pinging the Report Server facade. + + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts rolling back a report revision. + + An integer value, specifying the report ID. + An integer value, specifying the revision ID. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts saving the specified report. + + An integer value, specifying the report ID. + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts updating the data model. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts updating the specified report. + + An integer value, specifying the report ID. + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts updating the specified report category. + + An integer value specifying the report category ID. + A value specifying the new category name. + A nullable integer value specifying a report category version used for optimistic locking. + References a method to be called when a corresponding asynchronous operation is completed. + A value containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts updating the scheduled job. + + A object. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Starts uploading a report layout. + + A object, containing the report layout. + References a method to be called when a corresponding asynchronous operation is completed. + A value, containing information about the asynchronous operation. + An object containing information about the status of an asynchronous operation. + + + + Ends creating a report copy. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends creating a report. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends creating a report category. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the report category ID. + + + + Ends creating a scheduled job. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the scheduled job ID. + + + + Ends deleting a report category. + + An object containing information about the status of an asynchronous operation. + + + + Ends deleting a data model. + + An object containing information about the status of an asynchronous operation. + + + + Ends deleting a report. + + An object containing information about the status of an asynchronous operation. + + + + Ends deleting a scheduled job. + + An object containing information about the status of an asynchronous operation. + + + + Begins executing a scheduled job. + + An object containing information about the status of an asynchronous operation. + A nullable integer value. + + + + Ends obtaining the report categories. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the columns from a data source. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the data members from a data source. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining a data model. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends obtaining the available data models. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the data sources. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the report revisions. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the reports. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the scheduled job. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends obtaining the scheduled job logs. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the total number of scheduled job logs. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the total number of scheduled job logs. + + + + Ends obtaining the scheduled job result. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends obtaining the scheduled job results. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends obtaining the total number of results corresponding to a scheduled job log. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the total number of scheduled job results. + + + + Ends obtaining the scheduled jobs. + + An object containing information about the status of an asynchronous operation. + A collection of objects. + + + + Ends loading the reports. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Ends loading the report layout bytes. + + An object containing information about the status of an asynchronous operation. + A array, containing the report layout. + + + + Ends pinging the Report Server facade. + + An object containing information about the status of an asynchronous operation. + + + + Ends rolling back a report revision. + + An object containing information about the status of an asynchronous operation. + + + + Ends saving the specified report. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the report ID. + + + + Ends updating a data model. + + An object containing information about the status of an asynchronous operation. + + + + Ends updating the specified report. + + An object containing information about the status of an asynchronous operation. + An integer value, specifying the report ID. + + + + Ends updating a report category. + + An object containing information about the status of an asynchronous operation. + + + + Ends updating the scheduled job. + + An object containing information about the status of an asynchronous operation. + + + + Ends uploading a report layout. + + An object containing information about the status of an asynchronous operation. + A object. + + + + Obtains the data source schema. + + An integer value, specifying the data source ID. + A value, containing information about the asynchronous operation. + A value, containing the data source schema. + + + + Returns a data transfer object (DTO), corresponding to the report catalog item. + + An integer value, specifying the report ID. + A value. + + + + Locks the specified report. + + An integer value, specifying the report ID. + + + + Unlocks the specified report. + + An integer value, specifying the report ID. + + + + Provides the client-side functionality for a DevExpress Report Server. + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the interface. + A value, containing the address of the Report Server’s REST endpoint. + + + + Initialize a new instance of the class with the specified settings. + + An object implementing the interface. + + + + Creates a copy of the specified report. + + A System.Int32 value specifying a source report. + A data transfer object specifying properties of the created report copy. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Provides the controls for the context of a channel. + + An object implementing the System.ServiceModel.IContextChannel interface. + + + + Asynchronously creates a report category. + + A value, specifying the report category name. + A value, containing information about the asynchronous operation. + A , specifying the category ID. + + + + Creates a new report on the server. + + A data transfer object specifying properties of the created report. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously creates a new report. + + A object, providing information about the report. + A value, containing information about the asynchronous operation. + A , specifying the . + + + + Creates a new report category with the specified name. + + A System.String value specifying a category name. + A value, containing information about the asynchronous operation. + A System.Action delegate to be callled when the operation is complete. + + + + Asynchronously creates a scheduled job. + + A object, specifying properties of the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying the job ID. + + + + Asynchronously deletes a report category. + + An integer value, identifying the report category. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Asynchronously deletes a data model. + + An integer value, identifying the data model. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Deletes the specified report. + + A System.Int32 specifying a report to delete. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Deletes the specified report category. + + A System.Int32 value specifying a report category to delete. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously deletes a scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Asynchronously executes a scheduled job. + + An integer value, identifying the scheduled job. + A nullable integer value. + A value, containing information about the asynchronous operation. + A , specifying the job ID. + + + + Returns a collection of items to be displayed in the categories list. + + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously returns a collection of report categories. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously obtains a collection of columns available in the specified data member. + + A value, specifying a data source. + A value, specifying a data member. + A value, containing information about the asynchronous operation. + + + + Asynchronously returns the data columns corresponding to a specified data member. + + A value, specifying the data source name. + A object, identifying the data member. + An asynchronous operation result, containing a collection of objects. + + + + Occurs when data member columns have been obtained. + + + + + Asynchronously obtains a collection of data members available in the specified data source. + + A value, specifying a data source. + A value, containing information about the asynchronous operation. + + + + Asynchronously returns the list of data members corresponding to a specified data source. + + A value, specifying the data source name. + An asynchronous operation result, containing a collection of objects. + + + + Occurs when a collection of data members has been obtained. + + + + + Asynchronously gets a data model. + + An integer value, identifying the data model. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously gets a collection of data models. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the list of available data sources. + + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously obtains a collections of data sources available on a server. + + A value, containing information about the asynchronous operation. + + + + Obtains an XML schema of the specified data source. + + A System.Int32 value specifying a data source. + A value, containing information about the asynchronous operation. + A System.String containing a data source schema. + + + + Occurs when a collection of data sources has been obtained. + + + + + Gets properties of the specified report to be displayed in a report catalog. + + A System.Int32 value specifying a report. + A data transfer object containing the values of the report properties to be displayed in a report catalog. + + + + Gets a collection of revisions for the specified report. + + A System.Int32 value specifying a report. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Gets a collection of items to be displayed in a report catalog. + + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously gets a collection of reports. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns a specified scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously returns the logs corresponding to a specified scheduled job. + + An integer value, identifying the scheduled job. + A descendant, specifying how the data should be paginated. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the total number of logs corresponding to a specified scheduled job. + + An integer value, identifying the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying the total number of logs. + + + + Asynchronously returns the result of a scheduled job. + + An integer value, identifying the result of a scheduled job. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a object. + + + + Asynchronously returns the history of results corresponding to a specified scheduled job log. + + An integer value, identifying the scheduled job log. + A descendant, specifying how the data should be paginated. + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Asynchronously returns the total number of results corresponding to a specified scheduled job log. + + An integer value, identifying the scheduled job log. + A value, containing information about the asynchronous operation. + A , specifying the total number of job results. + + + + Asynchronously returns all scheduled jobs. + + A value, containing information about the asynchronous operation. + An asynchronous operation result, containing a collection of objects. + + + + Loads the specified report from the server storage. + + A System.Int32 specifying a report to load. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously loads a report. + + An integer value, identifying the report. + A value, containing information about the asynchronous operation. + A , specifying the . + + + + Gets the specified revision of a report layout. + + A System.Int32 value specifying a report. + A System.Int32 value specifying a report revision. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Locks the specified report. + + A System.Int32 specifying the report to lock. + + + + Checks a server for availability. + + A System.Action delegate to be called when the operation is complete. + A value, containing information about the asynchronous operation. + + + + Rolls the layout of a report back to the specified revision. + + A System.Int32 value specifying a report to roll back. + A System.Int32 value specifying a target layout revision. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Saves the specified report to the server storage. + + A System.Int32 value specifying a report to save. + A Data Transfer Object containing report data. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Unlocks the specified report. + + A System.Int32 specifying the report to unlock. + + + + Asynchronously updates a report category. + + An integer value identifying the report category. + A value specifying the report category name. + A nullable integer value specifying a category version used for optimistic locking. + A value containing information about the asynchronous operation. + A specifying an asynchronous operation. + + + + Asynchronously updates a data model. + + A object. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Updates properties of the specified report. + + A System.Int32 value specifying a report to update. + A data transfer object containing new values for report properties. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously updates an existing report. + + An integer value, identifying the report. + A object, providing information about the report. + A value, containing information about the asynchronous operation. + A , specifying the report ID. + + + + Updates properties of the specified report category. + + A System.Int32 value specifying a report category to update. + A System.String specifying a category name. + A nullable integer value specifying a report category version used for optimistic locking. + A value containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Asynchronously updates a scheduled job. + + A object, specifying properties of the scheduled job. + A value, containing information about the asynchronous operation. + A , specifying an asynchronous operation. + + + + Uploads report layout data onto a server. + + A System.IO.Stream containing layout data. + A value, containing information about the asynchronous operation. + A System.Action delegate to be called when the operation is complete. + + + + Supports automatic creation on the client side. + + + + + Initializes a new instance of the class with the specified remote address and binding. + + An object. + A object. + + + + Initializes a new instance of the class with the specified remote address. + + An object. + + + + Initializes a new instance of the class with the specified endpoint configuration name and remote address. + + A value, specifying the endpoint configuration name. + An object. + + + + Initializes a new instance of the class with the specified endpoint configuration name. + + A value, specifying the endpoint configuration name. + + + + Creates a . + + An object implementing the interface (typically, this is a object). + + + + Provides methods for converting components to specific types. + + + + + Initializes a new instance of the class with the default settings. + + + + + Checks whether or not the component can be converted to the specified type. + + An object implementing the interface. + A enumeration value. + true if the valid conversion is possible; otherwise false. + + + + Converts the component to the specified type. + + An object implementing the interface. + A object. + A value. + A enumeration value. + A value. + + + + Contains classes that enable users to connect to the Report and Dashboard Server. + + + + + The base for classes that provide the functionality to connect to the Report and Dashboard Server. + + + + + Initializes a new instance of the class with the specified server address. + + A value, specifying the server address. + + + + Asynchronously logins to a report server and initializes a report server client within the current login session. This method combines the functionality of the ConnectionProvider.LoginAsync and ConnectionProvider.CreateClient methods. + + A , specifying the object implementing the interface. + + + + Initializes a report service client within the current login session, established by calling the ConnectionProvider.LoginAsync method. + + An object implementing the interface. + + + + Asynchronously logins to a report server. + + A , specifying whether or not the connection to the report server was successful. + + + + Enables a client application to log in to the Report and Dashboard Server using the Guest account’s permissions. + + + + + Initializes a new instance of the class with the specified server address. + + A value, specifying the server address. + + + + Asynchronously logins to a report server. + + A , specifying whether or not the connection to the report server was successful. + + + + Enables a client application to log in to the Report and Dashboard Server using the Forms authentication. + + + + + Initializes a new instance of the class with the specified server address and user credentials. + + A value, specifying the server address. + A value, specifying the user name. + A value, specifying the user password. + + + + Asynchronously logins to a report server. + + A , specifying whether or not the connection to the report server was successful. + + + + Enables a client application to log in to the Report and Dashboard Server using the Windows Authentication. + + + + + Initializes a new instance of the class with the specified server address. + + A value, specifying the server address. + + + + Asynchronously logins to a report server. + + A , specifying whether or not the connection to the report server was successful. + + + + Contains classes that provide data transfer object (DTO) functionality to the service model of a Report and Dashboard Server. + + + + + A data transfer object (DTO) that provides the information about a report category. + + + + + Initializes a new instance of the class with the default settings. + + + + + Identifies the category. + + An integer value. + + + + Specifies the category name. + + A value. + + + + Identifies the category version used for optimistic locking. + + A nullable integer value that specifies the category version. + + + + Provides information about the created report. + + + + + Initializes a new instance of the class with the default settings. + + + + + Identifies the report version used for optimistic locking. + + A nullable integer value that specifies the report version. + + + + Identifies the report. + + An integer value. + + + + Identifies the report revision. + + An integer value. + + + + A data transfer object (DTO) that provides the information about a data model. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the connection string. + + A value. + + + + Specifies the database schema. + + A value. + + + + Specifies the data model description. + + A value. + + + + Specifies the data model ID. + + An integer value, identifying the data model. + + + + Specifies the data model name. + + A value. + + + + Identifies the data model version used for optimistic locking. + + A nullable integer value that specifies the data model version. + + + + Specifies the data provider. + + A value. + + + + The base for classes that provide the data pagination functionality. + + + + + Enables you to paginate the obtained data by the specified number of records. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the maximum number of records that a single data page can contain. + + An integer value. + + + + Specifies the record number from which the page’s data count starts. + + An integer value. + + + + Enables you to paginate the obtained data by the specified time span. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the date and time of the first record on the data page. + + A structure. + + + + Specifies the time interval to be included on the data page. + + A structure. + + + + Lists the available reference points that can be used to calculate date-time parameter values. + + + + + The reference point corresponds to the end of the current day. + + + + + The reference point corresponds to the end of the current month. + + + + + The reference point corresponds to the end of the current quarter. + + + + + The reference point corresponds to the end of the current week. + + + + + The reference point corresponds to the end of the current year. + + + + + The reference point corresponds to the end of the next day. + + + + + The reference point corresponds to the end of the next month. + + + + + The reference point corresponds to the end of the next quarter. + + + + + The reference point corresponds to the end of the next week. + + + + + The reference point corresponds to the end of the next year. + + + + + The reference point corresponds to the end of the previous day. + + + + + The reference point corresponds to the end of the previous month. + + + + + The reference point corresponds to the end of the previous quarter. + + + + + The reference point corresponds to the end of the previous task. + + + + + The reference point corresponds to the end of the previous week. + + + + + The reference point corresponds to the end of the previous year. + + + + + The reference point corresponds to the start of the current day. + + + + + The reference point corresponds to the start of the current month. + + + + + The reference point corresponds to the start of the current quarter. + + + + + The reference point corresponds to the start of the current week. + + + + + The reference point corresponds to the start of the current year. + + + + + The reference point corresponds to the start of the next day. + + + + + The reference point corresponds to the start of the next month. + + + + + The reference point corresponds to the start of the next quarter. + + + + + The reference point corresponds to the start of the next week. + + + + + The reference point corresponds to the start of the next year. + + + + + The reference point corresponds to the start of the previous day. + + + + + The reference point corresponds to the start of the previous month. + + + + + The reference point corresponds to the start of the previous quarter. + + + + + The reference point corresponds to the start of the previous task. + + + + + The reference point corresponds to the start of the previous week. + + + + + The reference point corresponds to the start of the previous year. + + + + + Specifies whether recipients should receive individual emails, or a common email with all recipients listed in the “To” section. + + + + + All recipients receive the same email to which they are all listed in the “To” section. + + + + + Each recipient receives an individual email. + + + + + Lists the available report delivery formats. + + + + + Each email contains a report attached as an XLSX file. + + + + + Each email has a report embedded into its body as inline HTML content. + + + + + Each email contains a report attached as a PDF file. + + + + + Each email contains a URL, specifying the address of a web page that displays a report. + + + + + Identifies report documents generated by a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified ID. + + An integer value, identifying the report. + + + + Specifies the report ID. + + An integer value, identifying the report. + + + + Returns the textual representation of . + + A value. + + + + Lists the possible results of a scheduled job. + + + + + The task execution failed. + + + + + The task is currently being executed. + + + + + The task execution is postponed for one minute due to problems connecting to the Report Server or database. + + + + + The task execution was successful. + + + + + A data transfer object (DTO) that provides the information about a report revision layout. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the report revision commentary. + + A value. + + + + Identifies the report revision. + + An integer value. + + + + Specifies the date and time of the report revision. + + A structure. + + + + Specifies the report revision number. + + An integer value. + + + + Specifies the author of the report revision. + + A value. + + + + When scheduling a billing statement, enables you to specify a data model that contains a query, table or view storing recipient emails. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the name of a table, view or query from the selected data model. + + A value. + + + + Identifies the data model. + + An integer value, specifying the data model ID. + + + + Specifies the name of a data field containing the display name associated with the email address. + + A value. + + + + Specifies the name of a data field containing the list of recipient emails. + + A value. + + + + A data transfer object (DTO) that provides the information about a report catalog item. + + + + + Initializes a new instance of the class with the default settings. + + + + + Identifies the report catalog item’s category. + + An integer value. + + + + Specifies the report catalog item description. + + A value. + + + + Identifies the report category item. + + An integer value. + + + + Specifies the user who locked the report catalog item. + + A value. + + + + Specifies the last user who modified the report catalog item. + + A value. + + + + Specifies the date and time when the report catalog item was last modified. + + A structure. + + + + Specifies the report catalog item name. + + A value. + + + + Identifies the report catalog version used for optimistic locking. + + A nullable integer value that specifies the report catalog version. + + + + A data transfer object (DTO) that provides the information about a report. + + + + + Initializes a new instance of the class with the default settings. + + + + + Identifies the report category. + + An integer value. + + + + Specifies the report commentary. + + A value. + + + + Specifies the report description. + + A value. + + + + Identifies the report. + + An integer value. + + + + Specifies the report layout bytes. + + A array, specifying the report layout bytes. + + + + Specifies the report name. + + A value. + + + + Identifies the report version used for optimistic locking. + + A nullable integer value that specifies the report version. + + + + Identifies the report revision. + + An integer value. + + + + A data transfer object (DTO) that provides general information about a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether or not the task is allowed to run automatically. + + true if the task is allowed to run; otherwise false. + + + + Identifies the task. + + An integer value, specifying the task ID. + + + + Specifies the task name. + + A value, specifying the task name. + + + + Identifies the report generated by the task. + + A nullable integer value, specifying the report ID. + + + + Specifies the date and time at which the task should start running. + + A structure. + + + + Specifies whether the task should generate a report or billing statement. + + A enumeration value. + + + + A data transfer object (DTO) that provides detailed information about a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether or not to send blank reports by email, should they be created based on their underlying data. + + true to send blank reports by email; otherwise false. + + + + Specifies whether recipients should receive individual emails, or a common email with all recipients listed in the “To” section. + + An enumeration value. + + + + Specifies how reports should be delivered by email. + + An enumeration value. + + + + Specifies the path to a local or remote folder where the created reports should be stored. + + A value. + + + + Specifies the comma-separated list of email subscribers to the task that are not registered users of the Report Server. + + A value. + + + + Specifies the registered Report Server users subscribed to the task. + + A collection of integers, identifying user accounts subscribed to emails. + + + + Identifies the scheduled job version used for optimistic locking. + + A nullable integer value that specifies the scheduled job version. + + + + Specifies for how many days to store created documents on the server. + + An integer value, specifying the number of days for which the server must store created documents. A zero value indicates unlimited document storage time. + + + + Specifies the collection of report parameters whose values should be supplied by the scheduled task. + + A value. + + + + Specifies the serialized recurrence options of the task. + + A value, specifying the recurrence options of the task. + + + + A data transfer object (DTO) that provides a log storing the information about each run of a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the date and time at which a task execution was started. + + A structure. + + + + Identifies the executed task. + + An integer value, specifying the task ID. + + + + A data transfer object (DTO) that provides general information about the results of executing a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the date and time at which the task execution result was obtained. + + A structure. + + + + Identifies the result of a task execution. + + An integer value, specifying the task result ID. + + + + Specifies the status of a task or result of its execution. + + A enumeration value. + + + + A data transfer object (DTO) that provides detailed information about the results of executing a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Lists the values of parameters that were used to create a document. + + A value, listing parameters as name-value pairs separated by semicolons. + + + + Describes the error that prompted a task execution to fail. + + A value, specifying the error message. + + + + Lists the recipients that will receive created reports by email. + + A value. + + + + Lists the available task execution modes. + + + + + The task generates a set of uniform documents that are tailored to specific recipients. + + + + + The task generates a single report document that does not vary depending on who receives it. + + + + + A report parameter whose value should be supplied by a scheduled job. + + + + + Initializes a new instance of the class with the specified parameter source and value. + + A object. This value is assigned to the SchedulerParameter.Source property. + A value. This value is assigned to the SchedulerParameter.Value property. + + + + Initializes a new instance of the class with the specified parameter value. + + A value. This value is assigned to the SchedulerParameter.Value property. + + + + Specifies the source from which parameter values are supplied. + + A enumeration value. + + + + Specifies the parameter value. + + A value. + + + + A collection of report parameters whose values should be supplied by a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the binding that enables a parameter to obtain its values from a database table. + + A object. + + + + Specifies the dictionary storing the report parameters. + + A object. + + + + A serialized collection of report parameters whose values should be supplied by a scheduled job. + + + + + Initializes a new instance of the class with the default settings. + + + + + Lists the available kinds of sources from which report parameters can obtain their values to execute a scheduled job. + + + + + A parameter value is supplied from a specified data source. This option is only available when the ScheduledJobCatalogItemDto.TaskMode property is set to ScheduledTaskMode.BillingStatement. + + + + + A date-time parameter value is calculated at the time of performing the scheduled task and corresponds to the selected temporal reference point (e.g., start of the previous task or end of the previous month). + + + + + A parameter value is specified manually. + + + + + Temporarily identifies a report to provide its document for preview in an End-User Report Designer. + + + + + Initializes a new instance of the class with the default settings. + + + + + Returns the textual representation of . + + A value. + + + + Contains classes that provide the basic functionality for the DXPrinting for WPF library. To use these classes in XAML code, add the xmlns:dxp=”“ namespace reference. + + + + + Registers known types on a WCF-service. + + + + + For internal use. + + + + + “GetKnownTypes“ + + + + + Specifies whether or not a custom parameter type is registered. + + A enumeration value. + true if the parameter type is registered; otherwise false. + + + + Registers a collection of custom parameter types. + + A collection of objects. + + + + Registers a custom parameter type. + + A enumeration value. + + + + Registers an array of custom parameter types. + + An array of enumeration values. + + + + Registers a custom parameter type. + + + + + Contains classes providing CSV format-specific options. + + + + + Specifies options for exporting the document to CSV format. + + + + + Initializes a new instance of the class. + + + + + Provides access to the culture-specific settings of the document. + + A object that specifies the culture settings currently being used. By default, it is set to the System.Globalization.CultureInfo.InvariantCulture value. + + + + Gets the file format to which the document is exported. + + A XlDocumentFormat.Csv value that specifies the CSV document format. + + + + Gets or sets the character encoding of the CSV document. + + A object that specifies the character encoding of the CSV document. By default, System.Text.Encoding.UTF8. + + + + Gets whether a custom value separator is specified. + + True if a custom value separator is specified; otherwise, false. + + + + Gets the maximum number of columns supported by the output file format. + + An value that is the maximum number of columns. + + + + Gets the maximum number of rows supported by the output file format. + + An value that is the maximum number of rows. + + + + Gets or sets whether the newline character sequence is inserted after the last row of the resulting text. + + True, to insert newline after the last row in the exported text; otherwise, false. + + + + Gets or sets a character sequence used to define a new line. + + A value that is the character used to identify a new line in a CSV document. + + + + Gets or sets a value indicating whether to prevent Formula Injection into the CSV file. + + true, to prevent CSV Injection; otherwise, false. The default is false. + + + + Gets or sets whether to put quotes around all text values in CSV output. + + A DevExpress.XtraExport.Csv.CsvQuotation enumeration value that specifies whether to always quote text values, never put quotes around text values, or let the built-in algorithm decide. + + + + Sets value separator to its default character. + + + + + Gets a value indicating whether the document can contain multiple worksheets. + + Always false. + + + + Gets a value indicating whether the document can contain formulas. + + Always false. + + + + Gets a value indicating whether the document supports grouping functionality. + + Always false. + + + + Gets or sets the character that encloses values in the resulting text. + + A that is the character used as the text qualifier. By default, it is the double quotation mark. + + + + Gets or sets whether to use the cell Formatting.NumberFormat property to convert a cell numeric value to a string. + + True to use cell formatting to convert a cell value to a string; otherwise, false. + + + + Gets or sets a character used to separate values in the resulting text. + + A object that is the character used as a value separator. By default, it is “,” (comma). + + + + Gets or sets whether to write a prefix that is the sequence of bytes that specifies the encoding used. + + True to write a byte array containing a sequence of bytes that specifies the encoding used; otherwise, false. + + + + Lists characters used to identify a new line in a CSV document. + + + + + A carriage return character. + + + + + A carriage return/linefeed character combination. + + + + + A form feed character for the print function. + + + + + A line feed character. + + + + + A carriage linefeed/return character combination. + + + + + A vertical tab character. + + + + + Contains classes that provide the basic functionality for the XtraPrinting library (bricks, pages, document). + + + + + This class supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + For internal use. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Specifies whether the resulting file should be automatically opened in the default program, after exporting a document which is currently displayed in the Print Preview. + + + + + After exporting is finished, the message box with the following text is shown: “Do you want to open this file?”, so that an end-user may choose whether the resulting file should be automatically opened in the default program, or not. + + + + + No action is performed after exporting is finished. + + + + + After exporting is finished, the default program which is currently associated with the type of the resulting file is launched, and the file is automatically opened in this application. + + + + + Contains classes and enumerations that implement the bar code functionality in XtraPrinting. + + + + + The base class for generators of 2D bar codes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified source. + + A object. + + + + For internal use. + + A Boolean value. + + + + Lists the possible errors that may be identified during bar code validation. + + + + + The control’s dimensions are too small to correctly render the current bar code. + The displayed error message corresponds to the PreviewStringId.Msg_CantFitBarcodeToControlBounds enumeration value. + + + + + The binary data assigned to the bar code is longer than 1033 bytes or does not meet specific requirements of the current symbology. + The displayed error message corresponds to the PreviewStringId.Msg_InvalidBarcodeData enumeration value. + + + + + The bar code is assigned text containing invalid characters. + The displayed error message corresponds to the PreviewStringId.Msg_InvalidBarcodeText enumeration value. + + + + + The bar code text is incompatible with the selected symbology. + The displayed error message corresponds to the PreviewStringId.Msg_InvalidBarcodeTextFormat enumeration value. + + + + + No errors were detected during bar code validation. The bar code content is rendered correctly. + + + + + Defines the base class for all the classes used to generate bar codes. + + + + + Gets or sets whether to calculate a checksum for the bar code. + + true if the barcode object needs a checksum to be calculated; otherwise, false. + + + + For internal use. + + An object implementing the DevExpress.XtraPrinting.IGraphicsBase interface. + A structure. + An object implementing the interface. + + + + For internal use. + + An object implementing the interface. + A value. + + + + For internal use. + + An object implementing the interface. + A value. + + + + Gets the name of the bar code type, which is represented by a current class. + + A string, which is the name of the bar code type. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Indicates whether or not the bar code is correctly rendered. + + An object implementing the DevExpress.XtraPrinting.IGraphicsBase interface. + A structure. + An object implementing the interface. + + + + Specifies by what angle a bar code is rotated. + + + + + A bar code is displayed in its normal orientation. + + + + + A bar code is rotated 90 degrees counter clockwise. + + + + + A bar code is rotated 90 degrees clockwise. + + + + + A bar code is rotated 180 degrees. + + + + + Represents the class used to generate a Codabar barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true, to calculate a checksum for the barcode; false, otherwise. + + + + Gets or sets the first (start) symbol used to code the barcode’s structure. + + A enumeration value that specifies the start symbol. + + + + Gets or sets the last (stop) symbol used to code the barcode’s structure. + + A enumeration value that specifies the stop symbol. + + + + For internal use. Gets the barcode symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the density of a barcode’s bars. + + A float value specifying the density of a barcode’s bars. + + + + Specifies the first (start) and last (stop) symbols used to code the Codabar bar code structure. + + + + + The first element in a bar code is “A” and the last element is “T”. + + + + + The first element in a bar code is “B” and the last element is “N”. + + + + + The first element in a bar code is “C” and the last element is “*”. + + + + + The first element in a bar code is “D” and the last element is “E”. + + + + + The are no start (first) and stop (last) elements used in a bar code. + + + + + Specifies the first (start) and last (stop) symbols used to code the Codabar bar code structure. + + + + + The first/last element in a bar code is “A”. + + + + + The first/last element in a bar code is “B”. + + + + + The first/last element in a bar code is “C”. + + + + + The first/last element in a bar code is “D”. + + + + + The first/last element in a bar code is not specified. + + + + + Represents the class used to generate a Code 11 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Specifies the character set that is used to encode characters of the Code 128 bar code. + + + + + Includes ASCII characters 00 to 95 (0-9, A-Z and control codes), special characters and FNC 1 (code that is used for special purposes). + + + + + Uses A, B and C character sets and switches between them automatically according to bar code text. + + + + + Includes ASCII characters 32 to 127 (0–9, A–Z, a–z), special characters, and FNC 1 (code that is used for special purposes). + + + + + Includes ASCII digit strings (00-99) and FNC 1 (code that is used for special purposes). + + + + + Represents the class used to generate a Code 128 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Adds a zero sign prefix to the number that is being encoded. + + true to add a leading zero to the encoded numbers; otherwise false. + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + Gets or sets the character set type for the bar code. + + A enumeration value, specifying a character set to be used. + + + + A substring/character that serves as the placeholder for the FNC1 functional character. + + A value that specifies the symbols to be replaced. + + + + A substring/character that serves as the placeholder for the FNC2 functional character. + + A value that specifies the symbols to be replaced. + + + + A substring/character that serves as the placeholder for the FNC3 functional character. + + A value that specifies the symbols to be replaced. + + + + A substring/character that serves as the placeholder for the FNC4 functional character. + + A value that specifies the symbols to be replaced. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate a Code 39 Extended barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate a Code 39 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the density of a bar code’s bars. + + A float value specifying the density of a bar code’s bars. + + + + Represents the class used to generate a Code 93 Extended barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate a Code 93 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an MSI barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + Gets or sets the checksum type for the bar code. + + An enumeration value which represents the checksum type. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Defines a QR code’s corner frame. + + + + + Initializes a new instance of the class. + + + + + Generates a GS1 (DataBar) barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether or not to calculate a checksum for the bar code. + + true, if the bar code object requires a checksum calculation; otherwise, false. + + + + Specifies the symbol (or set of symbols) in the bar code’s text that will be replaced with the FNC1 functional character when the bars are drawn. + + A value, specifying the symbols to be replaced. + + + + Gets or sets the number of data segments per row in the Expanded Stacked type of a GS1 DataBar bar code. + + A System.Int32 value specifying a number of data segments per row. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the type of a GS1 DataBar bar code. + + A value specifying the GS1 DataBar bar code’s type. + + + + Lists the values used to specify the type of the DataBar bar code. + + + + + A GS1 DataBar Expanded bar code is generated. + + + + + A GS1 DataBar Expanded Stacked bar code is generated. + + + + + A GS1 DataBar Limited bar code is generated. + + + + + A GS1 DataBar Omnidirectional bar code is generated. + + + + + A GS1 DataBar Stacked bar code is generated. + + + + + A GS1 DataBar Stacked Omnidirectional bar code is generated. + + + + + A GS1 DataBar Truncated bar code is generated. + + + + + Specifies the kind of data that should be coded into the ECC200 - Data Matrix and PDF417 bar codes. + + + + + Data is encoded into text using the ASCII standard, which uses 4 bits (for double digits), 8 bits (for ASCII 0-127 symbols), or 16 bits (for ASCII 128-255 symbols). + + + + + Data is encoded into a binary array, using 8 bits per symbol. + + + + + Data is encoded into text using the C40 standard, which uses 5.33 bits (for upper register characters and digits) or 10.66 bits (for lower register and special characters) per symbol. + + + + + Data is encoded into text using the EDIFACT standard, which uses 6 bits per symbol. + + + + + Data is encoded into text, which uses 5.33 bits (for upper register characters and digits) or 10.66 bits (for lower register and special characters) per symbol. + + + + + Data is encoded into text using the X12 standard, which uses 5.33 bits (for upper register characters, digits and the three standard ANSI X12 terminator and separator characters) or 10.66 bits (for lower register and special characters) per symbol. + + + + + Generates an ECC200 - Data Matrix barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified source. + + A object. + + + + Gets or sets whether text or binary mode should be used to encode the barcode’s data. + + A enumeration value. + + + + Gets or sets the bar code matrix size. + + A enumeration value. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Generates a GS1 (Data Matrix) barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified source. + + A object. + + + + Specifies whether textual information or a byte array should be used as the bar code’s data, as well as its encoding. + + A enumeration value. + + + + Specifies the symbol (or set of symbols) in the bar code’s text that will be replaced with the FNC1 functional character when the bar code’s bars are drawn. + + A value, specifying the symbols to be replaced. + + + + Specifies whether or not parentheses should be included in the bar code’s text. + + true to insert parentheses into the bar code’s printed text; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Lists the available data matrix size options related to the ECC200 - Data Matrix bar code. + + + + + The bar code matrix size is 104x104. + + + + + The bar code matrix size is 10x10. + + + + + The bar code matrix size is 120x120. + + + + + The bar code matrix size is 12x12. + + + + + The bar code matrix size is 12x26. + + + + + The bar code matrix size is 12x36. + + + + + The bar code matrix size is 132x132. + + + + + The bar code matrix size is 144x144. + + + + + The bar code matrix size is 14x14. + + + + + The bar code matrix size is 16x16. + + + + + The bar code matrix size is 16x36. + + + + + The bar code matrix size is 16x48. + + + + + The bar code matrix size is 18x18. + + + + + The bar code matrix size is 20x20. + + + + + The bar code matrix size is 22x22. + + + + + The bar code matrix size is 24x24. + + + + + The bar code matrix size is 26x26. + + + + + The bar code matrix size is 32x32. + + + + + The bar code matrix size is 36x36. + + + + + The bar code matrix size is 40x40. + + + + + The bar code matrix size is 44x44. + + + + + The bar code matrix size is 48x48. + + + + + The bar code matrix size is 52x52. + + + + + The bar code matrix size is 64x64. + + + + + The bar code matrix size is 72x72. + + + + + The bar code matrix size is 80x80. + + + + + The bar code matrix size is 88x88. + + + + + The bar code matrix size is 8x18. + + + + + The bar code matrix size is 8x32. + + + + + The bar code matrix size is 96x96. + + + + + The bar code matrix size is auto-adjusted, depending on the quantity of encoded data. + + + + + Generates a visual representation of the Deutsche Post Identcode barcode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + For internal use. + + + + + Generates a visual representation of the Deutsche Post Leitcode barcode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + For internal use. + + + + + Represents the class used to generate an EAN-128 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. + + + + + Gets or sets the symbol (or set of symbols) in the bar code’s text that will be replaced with the FNC1 functional character when the bar code’s bars are drawn. + + A specifying the symbols to be replaced. + + + + Specifies whether or not parentheses should be included in the bar code’s text. + + true to insert parentheses into the bar code’s printed text; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an EAN 13 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an EAN 8 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Contains classes and enumerations used to convert separate data elements in the format required for EPC QR Codes. + + + + + Converts data elements into the format required for EPC QR Codes. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a value for the BeneficiaryName data element. + + A value that specifies the name of the beneficiary. + + + + Gets or sets a value for the BIC data element. + + A value that specifies the BIC code of the beneficiary. + + + + Gets the binary representation of the data for the EPC QR Code. + + A array + + + + Gets or sets the encoding (character set) for EPC QR Codes. + + An enumeration value that specifies the encoding. + + + + Gets or sets a value for the IBAN data element. + + A value that specifies the IBAN of the account of the beneficiary. + + + + Gets or sets a value for the Information data element. + + A value that specifies the beneficiary to the originator information. + + + + Gets or sets a value for the PaymentReference data element. + + A value that specifies the payment information. + + + + Gets or sets a value for the RemittanceInformation data element. + + A value that specifies the remittance information. + + + + Gets the string representation of the data for the EPC QR Code. + + A value that represents the EPC QR Code data. + + + + Gets or sets a value for the TransferAmount data element. + + A value that specifies the transfer amount. + + + + Gets or sets the TransferPurpose data element. + + A that specifies the purpose of the transfer. + + + + Validates data elements for the EPC QR Code. + + An error message shown if the validation fails. + true if the validation succeeded; otherwise, `false``. + + + + Gets or sets the EPC QR Code version. + + An enumeration value that specifies the version. + + + + Specifies the encoding (character set) for the EPC QR Code. + + + + + ISO 8859-1 + + + + + ISO 8859-10 + + + + + ISO 8859-15 + + + + + ISO 8859-2 + + + + + ISO 8859-4 + + + + + ISO 8859-5 + + + + + ISO 8859-7 + + + + + UTF-8 + + + + + Specifies the EPC QR Code version. + + + + + 001 + + + + + 002 + + + + + Specifies the amount of redundancy built into the coding of the PDF417 bar code to compensate for calculation errors. + + + + + Identifies the zero error correction level of the PDF417 bar code. + + + + + Identifies the first error correction level of the PDF417 bar code. + + + + + Identifies the second error correction level of the PDF417 bar code. + + + + + Identifies the third error correction level of the PDF417 bar code. + + + + + Identifies the fourth error correction level of the PDF417 bar code. + + + + + Identifies the fifth error correction level of the PDF417 bar code. + + + + + Identifies the sixth error correction level of the PDF417 bar code. + + + + + Identifies the seventh error correction level of the PDF417 bar code. + + + + + Identifies the eighth error correction level of the PDF417 bar code. + + + + + For internal use. Provides options that are used to manage a bar code’s content. + + + + + Gets the barcode‘s alignment settings. + + A enumeration value. + + + + Gets the value indicating whether or not the barcode‘s auto-module setting is enabled. + + true if the BarCodeBrick.AutoModule property is enabled; otherwise false. + + + + Gets the barcode‘s module setting. + + A value of the BarCodeBrick.Module property. + + + + Gets the barcode‘s orientation setting. + + A enumeration value. + + + + Gets the value indicating whether or not the barcode shows its text. + + true if the BarCodeBrick.ShowText property is enabled; otherwise false. + + + + Gets the bar code‘s style settings. + + A object that is assigned to the VisualBrick.Style property. + + + + Gets the bar code’s text. + + A value. + + + + Represents the class used to generate an Industrial 2 of 5 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the density of a bar code’s bars. + + A float value specifying the density of a bar code’s bars. + + + + Generates an Intelligent Mail barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. + + A Boolean value. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Generates an Intelligent Mail Package barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + This property is not in effect for the class. + + + + + This property is not in effect for the class. + + + + + This property is not in effect for the class. + + + + + Represents the class used to generate an Interleaved 2 of 5 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the density of a bar code’s bars. + + A float value specifying the density of a bar code’s bars. + + + + Generates an ITF-14 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the density of a bar code’s bars. + + A float value specifying the density of the bar code’s bars. + + + + Represents the class used to generate a Matrix 2 of 5 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Specifies which formula is used to calculate the checksum for the MSI bar code. + + + + + The checksum is calculated with respect to base 10 twice. + + + + + The checksum is calculated with respect to base 10. + + + + + The checksum is not calculated. + + + + + Identifies an EPC QR Code’s frame used in Payment Services Austria. + + + + + Initializes a new instance of the class. + + + + + Specifies the kind of data that should be coded into the PDF417 bar code. + + + + + Specifies that the byte array should be coded into the PDF417 bar code. + + + + + Specifies that the textual information should be coded into the PDF417 bar code. + + + + + Generates a PDF417 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified source. + + A object, which represents the source used to generate a PDF417 bar code. + + + + Gets or sets the number of bar code columns, which allows control of the logic width of the bar code. + + An integer, specifying the logic width of the bar code. + + + + Gets or sets whether text or binary mode should be used to encode the barcode’s data. + + A enumeration value. + + + + Gets or sets the amount of redundancy built into the bar code’s coding, to compensate for calculation errors. + + An enumeration value, specifying the error correction level. + + + + Gets or sets the number of bar code rows, which allows control of the logic height of the bar code. + + An integer, specifying the logic height of the bar code. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets whether the special end-symbol should be appended to the bar code. + + true if the end symbol should be appended; otherwise, false. + + + + Gets or sets the height-to-width ratio of a logical unit’s graphic representation. + + A value specifying the height-to-width ratio of a logical unit’s graphic representation. + + + + Generates a visual representation of the Pharmacode barcode. + + + + + Initializes a new instance of the class. + + + + + For internal use. + + A Boolean value. + + + + Specifies whether the Pharmacode bar code has one or two tracks. + + The type of the Pharmacode bar code. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Lists the types of the Pharmacode bar code. + + + + + A one-track Pharmacode bar code. + + + + + A two-track Pharmacode bar code. + + + + + Represents the class used to generate a PostNet barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Specifies the kind of data that should be coded into the QR Code. + + + + + A combination of alphabetic and numeric characters is encoded. Max. 4,296 characters. + + + + + Binary data is encoded. Max. 2,953 bytes. + + + + + Numeric data is encoded. Max. 7,089 characters. + + + + + Generates an EPC QR Code barcode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + A object. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Specifies the amount of redundancy built into the coding of the QR Code to compensate for calculation errors. + + + + + 30% codewords can be restored. + + + + + 7% codewords can be restored. + + + + + 15% codewords can be restored. + + + + + 25% codewords can be restored. + + + + + Generates a QR Code barcode. + + + + + For internal use. Initializes a new instance of the class with the default settings. + + + + + For internal use. Initializes a new instance of the class with the specified source. + + A object. + + + + Gets or sets whether numeric, alphanumeric or byte mode should be used to encode the barcode’s data. + + A enumeration value. + + + + Gets or sets the amount of redundancy built into the bar code’s coding, to compensate for calculation errors. + + A enumeration value. + + + + Gets or sets the frame for QR codes. + + A object that defines the frame options. + + + + Gets or sets whether to add a blank space around the QR code. + + true to display a quiet zone; otherwise, false. + + + + Specifies the image that overlays the QR code. + + The image to be displayed on the QR code. + + + + For internal use. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Gets or sets the bar code’s size. + + A enumeration value. + + + + Generates a GS1 (QR Code) barcode. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Specifies the symbol (or set of symbols) in the bar code’s text that will be replaced with the FNC1 functional character when the bar code’s bars are drawn. + + A value that specifies the symbols to be replaced. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Lists the values used to specify the QR Code bar code’s size. + + + + + The version is auto-calculated. + + + + + 21x21 + + + + + 57x57 + + + + + 61x61 + + + + + 65x65 + + + + + 69x69 + + + + + 73x73 + + + + + 77x77 + + + + + 81x81 + + + + + 85x85 + + + + + 89x89 + + + + + 93x93 + + + + + 25x25 + + + + + 97x97 + + + + + 101x101 + + + + + 105x105 + + + + + 109x109 + + + + + 113x113 + + + + + 117x117 + + + + + 121x121 + + + + + 125x125 + + + + + 129x129 + + + + + 133x133 + + + + + 29x29 + + + + + 137x137 + + + + + 141x141 + + + + + 145x145 + + + + + 149x149 + + + + + 153x153 + + + + + 157x157 + + + + + 161x161 + + + + + 165x165 + + + + + 169x169 + + + + + 177x177 + + + + + 33x33 + + + + + 177x177 + + + + + 37x37 + + + + + 41x41 + + + + + 45x45 + + + + + 49x49 + + + + + 53x53 + + + + + Contains options used to configure the frame for QR codes. + + + + + Specifies rounded corners for the rectangular frame in pixels. + + A single value that is the corner radius of the frame. + + + + Specifies the frame color. + + A object that defines the frame color. + + + + Specifies the frame width in pixels. + + A value that is the frame width in pixels. + + + + Specifies the distance between the frame and QR code. + + A object that defines paddings for the frame. + + + + Specifies the text that displayed in the frame. + + A value that defines the text displayed in the frame. + + + + Specifies how the text is aligned with the frame line. + + A value that defines the text alignment. + + + + Specifies the color of the text in the frame. + + A value that defines the color of the text in the frame. + + + + Specifies how the text is positioned against the QR code. + + A value that defines the text position. + + + + Lists values that used to set the text alignment for a QR Code’s frame. + + + + + The text is aligned to the baseline of the frame. + + + + + The text is aligned to the center of the frame. + + + + + Lists values that used to set the text position inside a QR Code’s frame. + + + + + The text is located at the bottom. + + + + + The text is on the left. + + + + + The text is on the right. + + + + + The text is located on top. + + + + + Defines a QR code’s rectangular frame. + + + + + Initializes a new instance of the class. + + + + + A class used to generate an SSCC bar code. + + + + + Initializes a new instance of the class. + + + + + This property has no effect for the SSCC barcode. + + A enumeration value that specifies a character set. + + + + This property has no effect for the SSCC barcode. + + A string with characters to be replaced. + + + + This property has no effect for the SSCC barcode. + + True to insert parentheses into the bar code’s printed text; otherwise, false. + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an UPC-A barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an UPC-E0 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an UPC-E1 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the barcode symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Defines the base class for the and classes. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + Represents the class used to generate an UPC Supplemental 2 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Represents the class used to generate an UPC Supplemental 5 barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + For internal use. Gets the bar code symbology for the current generator object. + + A DevExpress.XtraPrinting.BarCode.Native.BarCodeSymbology enumeration value. + + + + Defines the base class for the and classes. + + + + + Overrides the BarCodeGeneratorBase.CalcCheckSum property. + + true if the bar code object needs a checksum to be calculated; otherwise, false. + + + + A visual brick that contains a barcode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets or sets the alignment of the barcode in the brick rectangle. + + A enumeration value that specifies how the barcode is aligned within the brick. + + + + Gets or sets a value that specifies whether the BarCodeBrick.Module property value should be calculated automatically based upon the bar code’s size. + + true if the barcode’s module is calculated automatically; otherwise, false. + + + + Gets or sets the byte array to be coded into the PDF417 bar code. + + An array of values. + + + + For internal use only. + + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “BarCode”. + + + + Create a copy of the current object. + + An object that is a copy of the current object. + + + + Specifies the default text BarCodeBrick.Alignment. Currently it is set to TextAlignment.TopLeft value. + + + + + Specifies the default BarCodeBrick.AutoModule value. Currently it is set to false. + + + + + Gets or sets the default value for the BarCodeBrick.BinaryDataBase64 property. + + + + + Specifies the default BarCodeBrick.Module value. Currently it is set to 2.0 + + + + + Specifies the default BarCodeBrick.Orientation value. Currently it is set to BarCodeOrientation.Normal. + + + + + Specifies the default BarCodeBrick.ShowText value. Currently it is set to true. + + + + + For internal use only. + + A value. + + + + Gets or sets the symbology (code type) for the barcode and the text displayed in the . + + A object representing the symbology used in the current . + + + + Gets or sets the width of the narrowest bar or space in the current instance. + + A value which represents the width of the narrowest bar or space. + + + + Gets or sets how a barcode should be rotated in a report. + + A enumeration value specifying the angle at which a barcode is rotated. + + + + Gets or sets a value indicating whether the text is displayed in this . + + true if the text is displayed; otherwise, false. + + + + Specifies the bar code text. + + A value. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + Contains information about a bookmark that is related to a printing brick. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the IBrickOwner interface. This value is assigned to the BookmarkInfo.BrickOwner property. + A value. This value is assigned to the BookmarkInfo.Bookmark property. + A object. This value is assigned to the BookmarkInfo.ParentInfo property. + + + + Specifies the element’s bookmark. + + A value. + + + + Provides access to the bookmark’s owner brick. + + An object implementing the IBrickOwner interface. + + + + A value. + + + + + Specifies whether or not there are bookmarks specified for the brick. + + true, if there are bookmarks assigned to the element; otherwise false. + + + + Provides access to the bookmark’s parent brick. + + A object. + + + + Specifies information about the bookmark’s parent. + + A object. + + + + Represents a bookmark shown in the report’s document map. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified text, for the specified brick on the specified page. + + A specifying the bookmark’s text which will be shown in the document map. This value is assigned to the BookmarkNode.Text property. + A object representing the brick that the created bookmark will reference. This value is assigned to the BookmarkNode.Brick property. + A object representing the page on which the brick is situated. Note that this parameter is required because a brick may be split across two pages. This value is assigned to the BookmarkNode.Page property. + + + + Initializes a new instance of the class with the specified text, and for the specified pair of a brick and a page. + + A specifying the bookmark’s text which will be shown in the document map. This value is assigned to the BookmarkNode.Text property. + A object representing the brick-page pair, associated with the current bookmark. This value is assigned to the BookmarkNode.Pair property. + + + + Initializes a new instance of the class with the specified text. + + A specifying the bookmark’s text which will be shown in the document map. This value is assigned to the BookmarkNode.Text property. + + + + Gets the brick which the current bookmark is associated with. + + A object representing the brick which the current bookmark references. + + + + Gets a string value, which is intended for serialization of the bookmark’s page index. + + A value. + + + + Gets the collection of child bookmarks for the current bookmark. This collection is used when creating a hierarchical document map. + + A DevExpress.XtraPrinting.IBookmarkNodeCollection object representing the bookmarks which are shown as child bookmarks in a document map. + + + + Gets the page which contains the brick for the current bookmark. + + A object representing the page in the document which contains the brick for the current bookmark. + + + + Gets an index of a page, which contains a bookmark’s brick. + + An integer value representing a page index. + + + + Provides access to the brick-page pair, associated with the current bookmark. + + A object, representing a navigational brick-page pair. + + + + Gets the text of a bookmark node. + + A specifying the text shown for a bookmark in the document map. + + + + Represents a document map which contains a collection of all the bookmarks in a document. + + + + + Initializes a new instance of the class with the default settings. + + + + + The base for all visual brick classes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the description of an element used by assistive technologies. + + A string that is the textual description of an element. + + + + For internal use. + + An object that contains information for assistive technologies. + + + + Gets or sets an anchor name assigned to the object. + + A value. + + + + Gets a collection of bricks which are contained in this . + + Always returns the empty collection of bricks. + + + + Override this property to get the text string, containing the brick type information. + + + + + Releases all resources used by . + + + + + Returns an enumerator that can iterate through the collection of bricks. + + An object implementing the interface. + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + Defines the text displayed as the current brick hint. + + A value that represents the current brick hint text. + + + + Identifies the current brick. + + A used to identify a specific brick. + + + + Initializes a new instance of the class with the specified settings. + + A object which specifies the printing system used for the current graphics object. + A value which specifies the rectangle to be deflated. + + + + Specifies the visibility of . + + true if the brick is visible; otherwise false. + + + + Gets or sets the parent document band for the current brick. + + A DevExpress.XtraPrinting.Native.DocumentBand object which is the parent for this brick. + + + + Gets or sets the Printing System used to create and print this brick. + + A object which specifies the Printing System used to create and print this brick. + + + + Defines the current brick’s location and size, in GraphicsUnit.Document measurement units. + + A rectangle representing the current brick location and size. + + + + For internal use. + + A value. + A value. + A value. + + + + For internal use. + + + + + For internal use. + + A value. + + + + Override this property to specify whether the current brick can be divided into multiple parts when a document is repaginated. + + true if the current brick can be split; otherwise, false. + + + + Override this property to get or set the setting specifying whether the brick can be split horizontally on repagination. + + true if a brick can be divided horizontally; otherwise, false. + + + + Override this property to get or set the setting specifying whether the brick can be split vertically on repagination. + + true if a brick can be divided vertically; otherwise, false. + + + + For internal use. + + A value. + An value. + + + + For internal use. + + + + + Gets or sets the object that contains additional data associated with the control. + + An object that contains arbitrary information. + + + + Gets or sets the target attribute assigned to this and used when a Brick.Url property is specified. + + A value. + + + + For internal use. + + + + + For internal use. + + A value. + An value. + A Boolean value. + + + + For internal use. + + + + + Specifies the link to an external resource. + + A value representing the link to a resource. + + + + For internal use. Checks whether the specified brick fits the empty space on the bottom of the page, and if it doesn’t, moves it (or part of it) to the next page. + + A object specifying the new position of the current page. + true to forcibly split non-separable bricks; otherwise, false. + A object specifying the suggested new bottom position of the current page. + A DevExpress.XtraPrinting.IPrintingSystemContext interface, used to access page settings. + A value specifying the new location of the empty space on the bottom of the page. In an instance where the brick on the page has to be moved to the next page, the new bottom position of the current page will be returned. + + + + Checks whether the specified brick fits the empty space on the right side of the page and if it doesn’t, moves it (or part of it) to the next page. + + A value specifying the right edge of the current page. + A object specifying the suggested new right position of the current page. + A value specifying the new location of the empty space on the right side of the page. In an instance where the brick on the page has to be moved to the next page, the new right position of the current page will be returned. + + + + Gets or sets an object, containing additional information on the current brick. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + Additional information on the current brick. + + + + This class is the basic class for all brick classes. + + + + + Specifies whether or not a brick is displayed in a printed or exported document. + + true, to display a brick in a printed or exported document; false, to display a brick only in a preview. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Defines the current brick’s location, in GraphicsUnit.Document measurement units. + + A value that represents the current brick’s location. + + + + Specifies the page area for displaying a specific brick. + + A enumeration value that represents the page area for displaying a specific brick. + + + + Specifies whether or not a brick’s bounds can be clipped. + + true to disable clipping a brick’s bounds; otherwise false. + + + + Specifies whether the current brick will be printed. + + true, if the current brick will be printed, otherwise, false. + + + + Defines the current brick’s location and size, in GraphicsUnit.Document measurement units. + + A value that represents the current brick’s location and size. + + + + Specifies whether to repeat a brick for a content that is split across multiple pages vertically. + + true, to print a brick on each document page that corresponds to vertically split content; otherwise, false. + + + + Defines the current brick’s size, in GraphicsUnit.Document measurement units. + + A value that represents the current brick’s size. + + + + For internal use. + + + + + Serves as the base class for classes that represent collections of bricks. + + + + + Initializes a new instance of the class with the specified owner. + + A that is the owner of . + + + + Represents the base for all classes that provide data for the brick-related events. + + + + + Initializes a new instance of the class with the specified brick. + + A object specifying the brick for which an event has been raised. This value is assigned to the BrickEventArgsBase.Brick property. + + + + Gets a brick for which an event has been raised. + + A class descendant. + + + + Represents the base method for all brick-related events. + + The event sender. + A object that contains event data. + + + + Implements report drawing functions. + + + + + Initializes a new instance of the class with the specified printing system. + + A object which specifies the printing system used for the current graphics object. This value is assigned to the BrickGraphics.PrintingSystem property. + + + + Defines the background color for the current object. + + The background color for the current object. + + + + Starts to calculate the size of the rectangle required for all the bricks being added to the document. + + + + + Must be called before the creation of a brick group. + + + + + Specifies the border color for the current object. + + The border color for the current object. + + + + Specifies the border width of the current object. + + A value representing the border width, measured in units. + + + + Returns the dimensions of a report page without margins. + + Page dimensions without margins. + + + + Gets or sets the default . + + The default . + + + + Specifies the default font for a report. + + The default report font. + + + + For internal use. + + + + + Converts a value specified via the parameter to GraphicsUnit.Document measurement units. + + The value to convert. + A value in GraphicsUnit.Document measurement units. + + + + Adds a specific to a report. + + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for a specific . + The color to fill the background of a specific . + true, if the checkbox is in a checked state, otherwise, false. + The added to a report. + + + + Adds a specific to a report. + + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + true, if the checkbox is in a checked state, otherwise, false. + The added to a report. + + + + Adds a specific to a report. + + The location and size of the . + The added to a report. + + + + Adds a specific brick to a report. + + The image to draw within a specific brick. + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for a specific . + The color to be displayed in the transparent image. + The added to a report. + + + + Adds a specific brick to a report. + + The image to draw within a specific brick. + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + The added to a report. + + + + Adds a specific object to a document. + + A object specifying where the line starts. + A object specifying where the line ends. + A object specifying the line’s color. + A float value specifying the line’s width. + A object that represents the line drawn in the document. + + + + Adds a specific to a report. + + The image to draw in a specific brick. + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for a specific . + The color to be displayed in the transparent portions of an image. + The added to a report. + + + + Adds a specific to a report. + + The type of infomation, displayed in the . + The text to display in the . + The text color for the added . + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for the . + The added to a report. + + + + Adds a specific to a report. + + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for the current . + The background color for a brick. + The color of the brick’s border. + The added to a report. + + + + Adds a specific to a report. + + The text displayed in a specific . + The color used to draw text. + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + Border settings for a specific . + The added to a report. + + + + Adds a specific to a report. + + The text displayed in a specific . + The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value. + The added to a report. + + + + Finishes calculating the size of the rectangle required for all the bricks being added to the document. + + A object representing the rectangle containing all the bricks added after calling the BrickGraphics.BeginCalculateRectangle method. + + + + Indicates the completion of brick group creation. + + + + + Specifies the font of the current object. + + The font of the BrickGraphics object. + + + + Defines the foreground color of the current object. + + The foreground color of the current object. + + + + Measures the specified string when drawn. + + String to measure. + An object that contains font information. + The maximum width of the measured string. + An object that contains string format parameters. + An enumeration value that specifies the unit of measurement for the return value. + The string size, measured in pixels. + + + + Measures the specified string when drawn. + + String to measure. + An object that contains font information. + The maximum width of the measured string. + An object that contains string format parameters. + The string size, measured in pixels. + + + + Calculates the length of a specified text. + + The text to measure. + An object that contains font information. + The text length. + + + + Measures the height and width of the specified text string. + + String to measure. + A object that defines the text format of the string. + An integer value specifying the maximum width of the measured string. + A object that represents the string’s formatting. + A enumeration value that specifies the unit of measurement for the return value. + This method returns a structure that represents the size, measured in pixels. + + + + Calculates the length of a specified text. + + A value. + A object. + An integer value. + A object. + A structure, specifying the string length. + + + + Measures the specified string when drawn. + + String to measure. + The maximum width of the measured string. + An object that contains string format parameters. + The string size, measured in pixels. + + + + Measures the specified string when drawn with the specified maximum width and format. + + String to measure. + An integer value specifying the maximum width of the measured string. + The formatting settings for the measured string. + This method returns a structure that represents the size, measured in pixels. + + + + Measures the specified string when drawn with the specified maximum width. + + String to measure. + An integer value specifying the maximum width of the measured string. + This method returns a structure that represents the size, measured in pixels. + + + + Measures the specified string when drawn. + + String to measure. + This method returns a structure that represents the size, measured in pixels. + + + + Specifies the page area for displaying a specific brick. + + A enumerator value that defines the page area for displaying a specific brick. + + + + Defines the background color for all report pages. + + The background color of report pages. + + + + Defines graphic measurement units. + + Indicates the drawing unit. + + + + Gets the owner of the current object. + + The owner of the current object. + + + + Gets or sets text layout information (such as alignment, orientation and tab stops) and display manipulations (such as ellipsis insertion and national digit substitution). + + A object containing text information. + + + + Adds a new rectangle item to the rectangle that was calculated after the BrickGraphics.BeginCalculateRectangle method was called. + + A object representing the rectangle to be added. + + + + Converts the value specified via a parameter to the value that uses the current measurement units. + + The value to convert. + The obtained value in current measurement units. + + + + Specifies the report section’s modifiers. + + + + + Represents the detail section of the document. + + + + + Represents the detail footer section of the document. + + + + + Represents the detail header section of the document. + + + + + Represents the inner page footer section of the document. + + + + + Represents the inner page header section of the document. + + + + + Represents the marginal page footer section of the document. + + + + + Represents the marginal page header section of the document. + + + + + This value doesn’t represent any section of the document. It is used when specifying the LinkBase.SkipArea property, to specify that no section should be skipped when creating a document. Note that you can’t create a document using this brick modifier value. + + + + + Represents the report footer section of the document. + + + + + Represents the report header section of the document. + + + + + For internal use. An association of a brick and a page. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets a brick object of the brick-page pair. + + A object. + + + + Creates a new brick-page pair with the specified brick and page. + + A object specifying a brick component of the pair. This value is assigned to the BrickPagePair.Brick property. + A object specifying a page component of the pair. This value is assigned to the BrickPagePair.Page property. + A new instance with the specified values. + + + + For internal use. + + + + + Creates a new brick-page pair with the specified integer indices and page. + + An array of integer values, which specify indices for the created object. + A object specifying a page component of the pair. This value is assigned to the BrickPagePair.Page property. + A new instance with the specified values. + + + + Gets an empty brick-page pair. + + A BrickPagePair.Empty value, representing a brick-page pair with null components. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets a page object of the brick-page pair. + + A object. + + + + Selects bricks from a document or document page(s). + + + + + A static method that returns an enumeration of visual bricks from a document. + + The document from which to return visual bricks. + Visual bricks from the specified document. + + + + A static method that returns an enumeration of visual bricks from a document page. + + The page from which to return visual bricks. + Visual bricks from the specified page. + + + + A static method that returns an enumeration of visual bricks from document pages. + + A collection of pages from which to return visual bricks. + Visual bricks from the specified pages. + + + + A static method that returns an enumeration of visual brick descendants from a document. + + The document from which to return bricks. + The type of bricks to return. + Bricks from the specified document. + + + + A static method that returns an enumeration of visual brick descendants from a document page. + + The page from which to return bricks. + The type of bricks to return. + Bricks from the specified page. + + + + A static method that returns an enumeration of visual brick descendants from document pages. + + The pages from which to return bricks. + The type of bricks to return. + Bricks from the specified pages. + + + + A static method that returns an enumeration of visual bricks with the specified tag from a document. + + The document from which to return bricks. + The tag value. A brick is returned if its tag value matches the specified value. + Bricks from the specified document. + + + + A static method that returns an enumeration of visual bricks with the specified tag from a document page. + + The page from which to return bricks. + The tag value. A brick is returned if its tag value matches the specified value. + Bricks from the specified page. + + + + A static method that returns an enumeration of visual bricks with the specified tag from document pages. + + The pages from which to return bricks. + The tag value. A brick is returned if its tag value matches the specified value. + Bricks from specified pages. + + + + A static method that returns an enumeration of text bricks with specified text from a document. + + The document from which to return bricks. + The text value. A brick is returned if its text value matches the specified value. + Bricks from the specified document. + + + + A static method that returns an enumeration of text bricks with specified text from a document page. + + The page from which to return bricks. + The text value. A brick is returned if its text value matches the specified value. + Bricks from the specified page. + + + + A static method that returns an enumeration of text bricks with specified text from document pages. + + A collection of pages from which to return bricks. + The text value. A brick is returned if its text value matches the specified value. + Bricks from the specified pages. + + + + A static method that returns an enumeration of visual bricks generated by the specified XtraReport control from a document. + + The document from which to return bricks. + An XRControl descendant. A brick is returned if it was generated by this control. + Bricks from the specified document. + + + + A static method that returns an enumeration of visual bricks generated by the specified XtraReport control from a document page. + + The page from which to return bricks. + An XRControl descendant. A brick is returned if it was generated by this control. + Bricks from the specified page. + + + + A static method that returns an enumeration of visual bricks generated by the specified XtraReport control from document pages. + + The pages from which to return bricks. + An XRControl descendant. A brick is returned if it was generated by this control. + Bricks from the specified pages. + + + + Encapsulates text layout information (such as alignment, orientation and tab stops) and display manipulations (such as ellipsis insertion and national digit substitution). + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + An object from which to initialize a new object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the values of the specified source brick string format. It also uses the specified text and line alignment settings. + + A object whose values are used to initialize the item being created. + A enumeration value representing text alignment settings. This value is assigned to the BrickStringFormat.Alignment property. + A enumeration value representing line alignment settings. This value is assigned to the BrickStringFormat.LineAlignment property. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the values of the specified source brick string format. It also uses the specified formatting settings. + + A object whose values are used to initialize the item being created. + A enumeration value that represents formatting settings. This value is assigned to the BrickStringFormat.FormatFlags property. + + + + Initializes a new instance of the class with the values of the specified source brick string format. It also uses the specified trimming settings. + + A object whose values are used to initialize the item being created. + A enumeration value representing the trimming mode. This value is assigned to the BrickStringFormat.Trimming property. + + + + Initializes a new instance of the class with the values of the specified source brick string format. + + A object whose values are used to initialize the item being created. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified text and line alignment. + + A enumeration value representing text alignment settings. This value is assigned to the BrickStringFormat.Alignment property. + A enumeration value representing line alignment settings. This value is assigned to the BrickStringFormat.LineAlignment property. + + + + Initializes a new instance of the class with the specified string alignment. + + A enumeration value representing text alignment settings. This value is assigned to the BrickStringFormat.Alignment property. + + + + Initializes a new instance of the class with the specified source. + + A object from which to initialize a new object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value. This value is assigned to the BrickStringFormat.FormatFlags property. + A enumeration value. This value is assigned to the BrickStringFormat.Alignment property. + A enumeration value. This value is assigned to the BrickStringFormat.LineAlignment property. + A enumeration value. This value is assigned to the BrickStringFormat.Trimming property. + + + + Initializes a new instance of the class with the specified formatting information, text and line alignment settings. + + A enumeration value representing formatting information. This value is assigned to the BrickStringFormat.FormatFlags property. + A enumeration value representing text alignment settings. This value is assigned to the BrickStringFormat.Alignment property. + A enumeration value representing line alignment settings. This value is assigned to the BrickStringFormat.LineAlignment property. + + + + Initializes a new instance of the class with the specified formatting information. + + A enumeration value representing formatting information. This value is assigned to the BrickStringFormat.FormatFlags property. + + + + Gets or sets text alignment information. + + + + + Returns a object cloned from the current object, with the new string and line alignment applied. + + A enumeration value, representing new string alignment. + A enumeration value, representing new line alignment. + A cloned object. + + + + Returns a object cloned from the current object, with the new string alignment applied. + + A enumeration value, representing new string alignment. + A cloned object. + + + + Returns a object cloned from the current object. + + A StringFormatFlags enumeration value containing formatting information. + A cloned object. + + + + Returns a object cloned from the current object. + + A StringAlignment enumeration value representing line alignment. + A cloned object. + + + + Creates an exact copy of the object. + + A object created by this method. + + + + Creates a instance with the specified settings. + + A enumeration value. + true, to use the word wrap feature; otherwise false. + A enumeration value. + true, to use the right-to-left text orientation; otherwise false. + A value. + + + + Creates a new instance of the class with the specified settings. + + A enumeration value. + true to enable word-wrapping; otherwise, false. + A new instance with the specified values. + + + + Creates a new instance of the class with the specified settings. + + A enumeration value. + A enumeration value. + A enumeration value. + A new instance with the specified values. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets a StringFormatFlags enumeration that contains formatting information. + + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + Gets the object for this object. + + + + + Gets or sets line alignment. + + + + + Gets a prototype string format for the current string format. + + A enumeration value which specifies the prototype string format. + + + + Gets a value indicating whether or not the right-to-left orientation is used. + + true, if the text orientation is right-to-left; otherwise false. + + + + Gets text trimming mode. + + + + + Gets the StringFormat instance representing current text formatting. + + + + + Gets a value, specifying whether or not word-wrapping is available for the brick’s text. + + true if the word-wrapping is enabled; otherwise false. + + + + Specifies the prototype string format for the . + + + + + The current string format is based on the default string format. + + + + + The current string format is based on the generic default string format. + + + + + The current string format is based on the generic typographic string format. + + + + + Represents a report drawing style. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + A enumeration value that specifies the visible brick borders. This value is assigned to the BrickStyle.Sides property. + A value that specifies the border width. This value is assigned to the BrickStyle.BorderWidth property. + The border color. This value is assigned to the BrickStyle.BorderColor property. + The background color. This value is assigned to the BrickStyle.BackColor property. + The foreground color. This value is assigned to the BrickStyle.ForeColor property. + The font settings. This value is assigned to the BrickStyle.Font property. + A object that specifies the text format. This value is assigned to the BrickStyle.StringFormat property. + + + + Initializes a new instance of the class and copies the settings from the object passed as the parameter. + + A object whose settings are used to initialize the created object’s properties. + + + + Initializes a new instance of the class with the specified dpi value. + + A value which specifies the dpi value for the ‘s padding. + + + + Gets or sets the background color. + + A Color representing the background color. + + + + Gets or sets the border color. + + A Color representing the border color. + + + + Specifies the dash style for the brick’s border. + + A enumeration value. + + + + Gets or sets the border style of a brick. + + A enumeration value that represents the border style of a brick. + + + + Gets or sets the border width. + + A value. + + + + Gets or sets the string value used to support serialization of the BrickStyle.BorderWidth property. + + A value. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Creates the instance with the defaul settings. + + A object representing a new brick style. + + + + Gets the object whose properties are set to their default values. + + A object representing a report drawing style. + + + + Gets the default font for a brick style. + + The default font of a brick style. + + + + Deflates the specified rectangle by the specified width of the specified borders using the specified border style. + + A value which specifies the rectangle to be deflated. + One or more enumeration values, specifying which sides of a brick have borders. + A value which specifies the width of borders. + A enumeration value that specifies the brick style. + A value that represents the deflated rectangle. + + + + Deflates the specified rectangle by the width of borders represented by this brick style, and optionally applies the current border style. + + A value which specifies the rectangle to be deflated. + One or more enumeration values, specifying which sides of a brick have borders. + A value which specifies the dpi value to be applied to the width of borders before deflating. + true to apply the current border style; otherwise, false. The current border style can be accessed via the BrickStyle.BorderStyle property. + A value that represents the deflated rectangle. + + + + Deflates the specified rectangle by the specified width of the specified borders. + + A value which specifies the rectangle to be deflated. + One or more enumeration values, specifying which sides of a brick have borders. + A value which specifies the width of borders. + A value that represents the deflated rectangle. + + + + Deflates the specified rectangle by the width of borders represented by this brick style, and optionally applies the current border style. + + A value which specifies the rectangle to be deflated. + A value which specifies the dpi value to be applied to the width of borders before deflating. + true to apply the current border style; otherwise, false. The current border style can be accessed via the BrickStyle.BorderStyle property. + A value that represents the deflated rectangle. + + + + Deflates the specified rectangle by the width of borders represented by this brick style. + + A value which specifies the rectangle to be deflated. + A value which specifies the dpi value to be applied to the width of borders before deflating. + A value that represents the deflated rectangle. + + + + Disposes of the object. + + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets the Font used to display text. + + The font used to display text. + + + + Gets or sets the foreground color. + + The foreground color. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + Inflates the specified rectangle by the specified width of specified borders using the specified border style. + + A value which specifies the rectangle to be inflated. + A enumeration value that specifies which sides of a brick have borders. + A value which specifies the width of borders. + A enumeration value that specifies the brick style. + A value that represents the inflated rectangle. + + + + Inflates the specified rectangle by the specified width of specified borders. + + A value which specifies the rectangle to be inflated. + A enumeration value that specifies which sides of a brick have borders. + A value which specifies the width of borders. + A value that represents the inflated rectangle. + + + + For internal use. + + A structure. + A value. + A Boolean value. + A enumeration value. + A structure. + + + + Inflates the specified rectangle by the width of borders represented by this brick style, and optionally applies the current border style. + + A value which specifies the rectangle to be inflated. + A value which specifies the dpi value to be applied to the width of borders before inflating. + true to apply the current border style; otherwise, false. The current border style can be accessed via the BrickStyle.BorderStyle property. + A value that represents the inflated rectangle. + + + + Inflates the specified rectangle by the width of borders represented by this brick style. + + A value which specifies the rectangle to be inflated. + A value which specifies the dpi value to be applied to the width of borders before inflating. + A value that represents the inflated rectangle. + + + + Specifies whether or not the brick’s alignment is justified. + + true is the brick has a justified alignment; otherwise false. + + + + Gets a value indicating whether the brick style paints a transparent brick. + + true if the brick will be painted as transparent; otherwise, false. + + + + Gets or sets the padding values of a brick. + + A object which contains the padding values of a brick. + + + + Resets the BrickStyle.BackColor property value. + + + + + Resets the BrickStyle.BackColor property value. + + + + + Resets the BrickStyle.BorderDashStyle property value. + + + + + Resets all border settings. + + + + + Resets the BrickStyle.BorderWidth property value. + + + + + Resets the BrickStyle.Font property value. + + + + + Resets the BrickStyle.ForeColor property value. + + + + + Resets the BrickStyle.Padding property value. + + + + + Resets the BrickStyle.TextAlignment property value. + + + + + Rescales the brick style to the specified ratio. + + A value specifying the ratio to rescale the brick style. + A object which represents the brick style with the scaling applied. + + + + Sets the brick‘s alignment. + + A enumeration value. + A enumeration value. + + + + Gets or sets a value defining which borders of the current brick are visible. + + A enumerator value, defining visible brick borders. + + + + Gets or sets a instance specifying text formatting and layout. + + A specifying text formatting and layout. + + + + Gets or sets the alignment of the text in the brick. + + One of the enumeration’s values that specifies how the text is aligned in the brick. + + + + Contains classes that enable report document caching. + + + + + A component that manages caching logic and acts as a mediator between a report and a Document Viewer. + + + + + Creates the class’ instance and specifies the default settings. + + + + + Creates the class’ instance and specifies its CachedReportSourceBase.Report and CachedReportSourceBase.Storage properties. + + The report to be displayed and/or exported. + The storage used for caching the document that is generated from the specified report. + + + + Creates the class’ instance. + + A that represents a container for the Cached Report Source. + + + + Creates the class’ instance and specifies its CachedReportSourceBase.Report and CachedReportSourceBase.Storage properties. + + The report to be displayed and/or exported. + The storage used for caching the document that is generated from the specified report. + + + + Creates a document from the report specified by the CachedReportSourceBase.Report property, so it can be displayed, printed and exported. Runs document generation in an individual task asynchronously. + + The task where document generation is performed. + + + + Contains the basic functionality for the and classes. + + + + + Creates the class’ instance and specifies the default settings. + + + + + Creates the class’ instance and sets its CachedReportSourceBase.Report and CachedReportSourceBase.Storage properties. + + The report to be displayed and/or exported. + The storage used for caching the document that is generated from the specified report. + + + + Creates the class’ instance and sets its CachedReportSourceBase.Report and CachedReportSourceBase.Storage properties. + + The report to be displayed and/or exported. + The storage used for caching the document that is generated from the specified report. + + + + Indicates whether to generate information required for a single-file export. + + true to generate information required for a single-file export; false to prevent DocumentStorageLocation.ExportInfo generation. + + + + Creates a document from the report specified by the CachedReportSourceBase.Report property, so it can be displayed, printed and exported. + + + + + Creates a document from the report specified by the CachedReportSourceBase.Report property, so it can be displayed, printed and exported. Runs the document generation in an individual task asynchronously. + + The task where document generation is performed. + + + + Adds and/or removes the generated document’s pages. + + A delegate method that allows you to modify the report document using the object passed as a parameter. + + + + Specifies the page cache size. + + An integer that specifies the cache size. + + + + Provides access to the Printing System associated with the cached document. + + A instance that provides print and export capabilities for the cached document. + + + + Specifies the report for which a document is generated. + + The report for which a document is generated. + + + + Interrupts the document generation process. + + + + + Specifies a storage for the document generated from the CachedReportSourceBase.Report. + + The class’ descendant used to store a generated document in a certain place (e.g. a file system or database). + + + + A base class for storages used by the and objects to cache the document that they generate to display/export/print a report. + + + + + Deletes the storage’s content. + + + + + Specifies weather to delete the content located in the storage when it is disposed of. + + true, if the storage must be cleared. Otherwise, false. + + + + Disposes of the object. + + + + + Lists storage types that store document parts in a . + + + + + The -specific location that stores the elements that are common to the entire document, for instance, bookmarks, navigation, and page numbers. + + + + + The -specific location that stores data required to export the document in the continuous (single file) mode. + + + + + The for document images. + + + + + The -specific location that stores document metadata. + + + + + The -specific location that stores individual document pages. + + + + + A file storage used by the and objects to cache the document that they generate to display/export/print a report. + + + + + Creates the class’ instance and specifies the default settings. + + + + + Creates the class’ instance and specifies its FileDocumentStorage.DocumentFolder property. + + Specifies a path to the directory used to store a cached document. + + + + Deletes the folder where a cached document is stored. + + + + + Specifies the directory used to store a cached document. + + Specifies a path to the directory used to store a cached document. + + + + A memory storage used by the and objects to cache the document that it generates to display/export/print a report. + + + + + Creates the class’ instance and specifies the default settings. + + + + + Clears all the memory streams used to store the cached document. + + + + + Specifies the document changing permissions. + + + + + Permits any changes for the PDF document, except extracting its pages. + + + + + Permits commenting, filling in form fields, and signing existing signature fields for the PDF document. + + + + + Permits filling in form fields and signing existing signature fields for the PDF document. + + + + + Permits inserting, deleting and rotating the PDF document’s pages. + + + + + Specifies that no changes are permitted to the PDF document. + + + + + A visual brick containing text whose characters are displayed in individual cells. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string containing the brick type information. + + A string characterizing the brick’s type. Always returns “CharacterComb”. + + + + Specifies the cell height in a . + + A value specifying the cell height. + + + + Specifies the horizontal spacing between adjacent cells in a . + + A value. + + + + Specifies whether the cell size should depend on the current font size. + + A enumeration value. + + + + Specifies the vertical spacing between adjacent cells in a . + + A value. + + + + Specifies the cell width a . + + A value specifying the cell width. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Returns the ‘s client rectangle. + + A object specifying the brick layout rectangle. + A value specifying the printing resolution. + A object specifying the brick’s client rectangle. + + + + A visual brick containing a check box. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value. + A value, specifying the border width. + A value, specifying the border color. + A value, specifying the background color. + A value, specifying the foreground color. + + + + Initializes a new instance of the class with the specified visible borders, their width, color, and the background color of a check box brick. + + A enumeration value(s) which specifies the borders displayed around the brick. + A value which specifies the border width of the brick, measured in pixels. + A object which specifies the border color of the brick. + A object which specifies the background color of the brick. + + + + Initializes a new instance of the class with the specified brick style. + + A object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “CheckBox”. + + + + Gets or sets a value indicating whether the check box can be set to the value. + + true if the value can be used for setting the CheckBoxBrick.CheckState property; otherwise, false. + + + + Gets the size of a content shown within a check box brick. Use the property instead of CheckSize. + + A value, specifying the size of a check box content. + + + + Gets or sets the current state of the object. + + A enumeration value which determines the state of a checkbox. + + + + Gets or sets the text associated with the object. + + A value. + + + + Creates a new object that is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Stores a custom glyph image for each checkbox state (Checked/Unchecked/Indeterminate). + + Custom glyph images for each checkbox state + + + + Returns the check box birck’s state. + + A nullable Boolean value. + + + + Gets or sets the checkbox glyph pixel size. + + The checkbox glyph pixel size + + + + Gets or sets the checkbox glyph style. + + The checkbox glyph style + + + + Stores a custom glyph image for each checkbox state (Checked/Unchecked/Indeterminate). + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified glyph images collection. + + + + + This method is obsolete (this method is now obsolete. Use the Add(CheckBoxState checkState, ImageSource imageSource) method instead). + + + + + This property is obsolete (this indexer is now obsolete. Use the indexer that takes CheckBoxState as the key’s type instead). + + + + + An editing field for changing the state of a check box in Print Preview. + + + + + Creates a new instance of the class with the specified visual brick. + + A visual brick used to render an editing field in Print Preview. This value is assigned to the EditingField.Brick property. + + + + Specifies the current state of a object. + + A enumeration value which determines the state of a check box. + + + + Overrides the EditingField.EditValue property. + + + + + Specifies the ID of a logical group to which a belongs. + + A string that specifies the ID of a logical group owning the . + + + + Lists the values used to specify the column layout direction for a multi-column report. + + + + + The Detail bands are printed horizontally, then vertically (in rows). + + + + + The Detail bands are printed vertically, then horizontally (in columns). + + + + + Specifies the visibility levels for the printing system commands. + + + + + Both the command’s toolbar item and menu item are visible. + + + + + Deprecated; use CommandVisibility All instead. Both the command’s toolbar item and menu item are visible. + + + + + Both the command’s toolbar button and menu item are invisible. + + + + + Deprecated; use CommandVisibility All instead. Both the command’s toolbar item and menu item are visible. + + + + + Unites multiple visual bricks and defines how to render contained bricks on a document page. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A collection of objects. + A structure. + + + + Provides access to a collection of bricks contained within the instance. + + A collection of objects. + + + + Gets or sets the amounts to adjust the location of the CompositeBrick. + + A object, representing the adjustments of X and Y coordinates for the CompositeBrick. + + + + For internal use. + + + + + Provides data for all area creation events. + + + + + Gets a object used to draw in the current report. + + A object. + + + + A method that will handle all creation events of the class. + + The event source. + A that contains event data. + + + + Contains options which define how a document is exported to CSV format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified separator, encoding and other settings. + + A value, specifying the symbols that are used to separate the text elements in the created CSV file. This value is assigned to the TextExportOptionsBase.Separator property. + A descendant, specifying the encoding of the created CSV document. This value is assigned to the TextExportOptionsBase.Encoding property. + A enumeration value, specifying a format in which data values should be saved. This value is assigned to the TextExportOptionsBase.TextExportMode property. + true to include the empty rows into the resulting CSV file; otherwise false. This value is assigned to the CsvExportOptions.SkipEmptyRows property. + true to include the empty columns into the resulting CSV file; otherwise false. This value is assigned to the CsvExportOptions.SkipEmptyColumns property. + + + + Initializes a new instance of the class with the specified separator, encoding and text export mode settings. + + A containing symbols which will be used to separate the document’s text elements in the created CSV file. This value is assigned to the TextExportOptionsBase.Separator property. + A class descendant, specifying the encoding of the created CSV document. This value is assigned to the TextExportOptionsBase.Encoding property. + A enumeration value, specifying a format in which data values should be saved. This value is assigned to the TextExportOptionsBase.TextExportMode property. + + + + Initializes a new instance of the class with the specified separator and encoding settings. + + A value, specifying the symbols that are used to separate the text elements in the created CSV file. This value is assigned to the TextExportOptionsBase.Separator property. + A descendant, specifying the encoding of the created CSV document. This value is assigned to the TextExportOptionsBase.Encoding property. + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets whether to encode potentially dangerous content from a control or document when it is exported to a CSV file. + + True, to encode potentially dangerous content; otherwise, False. Default, to use the ExportSettings.EncodeCsvExecutableContent property value. + + + + Specifies if CSV export should follow the report layout. + + true, to follow the report layout in CSV export; false otherwise. + + + + Returns the character(s) used as text separators for CSV export. + + A value, specifying the actual separator character(s). + + + + Specifies the character(s) used to separate text elements when exporting a document to a text-based file. + + A value, specifying the separator character(s). + + + + Specifies whether or not to include the empty columns into the resulting CSV file. + + true to omit the empty columns during export; otherwise false. + + + + Specifies whether or not to include the empty rows into the resulting CSV file. + + true to omit the empty rows during export; otherwise false. + + + + Specifies whether to use the default system or a custom separator character for CSV export. + + true, to use a custom separator; otherwise, false. The default is false. + + + + Contains options that define how a control is exported to CSV format in data-aware export mode. + + + + + Initializes a new instance of the class with the default settings.Only available in data-aware export mode. + + + + + Initializes a new instance of the class with the specified settings.Only available in data-aware export mode. + + A value, specifying the symbols that are used to separate the text elements in the created CSV file. This value is assigned to the TextExportOptionsBase.Separator property. + A descendant, specifying the encoding of the created CSV document. This value is assigned to the TextExportOptionsBase.Encoding property. + A enumeration value, specifying a format in which data values should be saved. This value is assigned to the TextExportOptionsBase.TextExportMode property. + true to include the empty rows into the resulting CSV file; otherwise false. This value is assigned to the CsvExportOptions.SkipEmptyRows property. + true to include the empty columns into the resulting CSV file; otherwise false. This value is assigned to the CsvExportOptions.SkipEmptyColumns property. + + + + Fires consecutively for each control row when this row is about to be exported. Allows you to skip specific rows if they do not meet your custom criteria. + + + + + Allows you to substitute a cell value in the output document. Only available in data-aware export mode. + + + + + Gets or sets the export document’s culture which defines numeric and date-time data formatting settings.Only available in data-aware export mode. + + The export document’s culture + + + + Fires repeatedly while the data is being exported.Only available in data-aware export mode. + + + + + Gets or sets export type. + + The current export type. + + + + Specifies the symbol that is used to separate the text elements in the created CSV file.Only available in data-aware export mode. + + A containing the symbol which will be used to separate text elements in the created CSV file. + + + + Get or sets whether to include a sequence of bytes that specifies the encoding used in the resulting CSV file.Only available in data-aware export mode. + + true, to include a sequence of bytes that specifies the encoding used; otherwise, false. + + + + Contains classes and interfaces that implement printing of visual data nodes. + + + + + Specifies how groups of records should be split across pages, if required. + + + + + A group is printed so that it is split across several pages, if there isn’t enough space on a page to print the entire group. + + + + + A group is printed entirely on a single page (including its group header, rows and footer). This means that if there isn’t enough space on a page to print the entire group, this group is printed on the following page. + + + + + A group is split across several pages “as is”. However, if there isn’t enough space on a page to print a Group Header together with the following group row, they both are moved to the next page, so that a Group Header is never printed on a page alone (with no group rows below it). + + + + + For internal use. Exposes the printable content of a control to the DXPrinting engine. + + + + + If implemented by a class, returns the total number of detail rows. + + An integer value specifying the total detail count. + + + + The rendered and ready-to-print report document. + + + + + Specifies the number of virtual pages to fit into one physical page, so their total width is the same as the width of a physical page. + + An integer value, specifying the number of pages. + + + + For internal use. Specifies the base offset point for the created document. + + A value, specifying the offset point. + + + + Specifies the text of a root bookmark displayed in the Document Map. + + A value. + + + + Provides access to the collection of bookmarks available in the document and displayed in the Document Map of Print Preview. + + A DevExpress.XtraPrinting.IBookmarkNodeCollection object, specifying the collection of bookmarks. + + + + Specifies whether or not the document’s page settings can be changed. + + true, if page settings can be changed; otherwise, false. + + + + For internal use. + + + + + Disposes of the object. + + + + + For internal use. + + A object. + A object. + + + + Indicates whether or not the document is still being created. + + true, if the document creation is in progress; otherwise, false. + + + + Indicates whether or not the document has any pages. + + true, if the document has no pages; otherwise, false. + + + + Indicates whether or not the current instance is locked. + + true, if the document is locked; otherwise, false. + + + + Indicates whether or not any changes were made to the instance after it was created. + + true, if the document was modified; otherwise, false. + + + + Specifies the document name. + + A value. + + + + Indicates the total number of pages within a document. + + An integer value, specifying the number of document pages. + + + + Provides access to the collection of pages within the current document. + + A object, specifying the collection of pages. + + + + Provides access to the Printing System for the current document. + + A object. + + + + For internal use. + + + + + Specifies the document’s scale factor (in fractions of 1). + + A value, specifying the current scale factor. + + + + For internal use. + + + + + Override this method to draw the specified brick on a new page. + + A object. + + + + For internal use. Updates the value of the base offset point indicating the position where the new brick will be inserted into the document. + + + + + Provides options that specify the Document Properties of the resulting DOCX file. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies the settings from the specified object to the current object. + + An object whose settings are assigned to the current object. + + + + Specifies the document author. + + A value. + + + + Specifies the document category. + + A value. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Specifies the document comments. + + A value. + + + + Specifies the document keywords. + + A value. + + + + Specifies the document subject. + + A value. + + + + Specifies the document title. + + A value. + + + + Lists the available DOCX export modes. + + + + + A document is exported to a single file. In this mode, page headers and footers are added to the resulting DOCX file only once, at the beginning and end of the document. + + + + + A document is exported to a single file, page-by-page. + + + + + Contains options which define how a document is exported to DOCX format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether to embed floating pictures into exported DOCX files. + + true, to embed floating pictures into DOCX files; otherwise, false. + + + + Copies the settings from the specified object to the current object. + + An object whose settings are assigned to the current object. + + + + Provides access to an object, specifying the exported document’s options. + + A object. + + + + Gets or sets a value indicating how a document is exported to DOCX. + + An enumeration value that specifies the DOCX export mode. + + + + Specifies whether the height of table rows in a resulting document should have fixed values, or adding a new line of text to a cell’s content should increase the row height. + + true, to make the row height unaffected by adding new content to a cell; otherwise, false. + + + + Specifies whether to use the table or frame layout in the resulting DOCX file. + + true, to use a table layout; otherwise, false. + + + + Contains classes which are used to draw a watermark in XtraPrinting documents. + + + + + Specifies the incline of the ‘s text. + + + + + Specifies an incline from upper left to lower right. + + + + + Specifies an incline from upper right to lower left. + + + + + Specifies an incline from left to right. + + + + + Specifies an incline from top to bottom. + + + + + An image source that has an assigned ID. + + + + + Creates an object with the specified and properties. + + The image source ID. + An image source object that stores an image. + + + + Disposes of the object. + + + + + An ID for the specified image source. + + The image source ID. + + + + The image source that has the ID specified by the property. + + An object that stores an image. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + + + + Creates an object and adds it to the collection. + + The image item’s ID. + An object that stores an image. + + + + Adds an array of image items to the end of the collection. + + An array of image items to append to the collection. + + + + Determines whether the collection contains the specified image item. + + The image item’s ID. + true, if the collection contains the specified image item; otherwise, false. + + + + Disposes of the object. + + + + + Returns the image source of the image item that has the specified ID. + + The ID of the requested image item. + An object that stores an image. + + + + An object that stores a specified image. + + + + + Initializes a new instance of the class with specified settings. + + An image the ImageSource object stores. + true if the created image source is used by multiple objects; otherwise, false. + + + + Initializes a new instance of the class with specified settings. + + An image the ImageSource object stores. + + + + Creates an ImageSource object and sets its ImageSource.SvgImage property to the SVG image passed as a parameter. + + An SVG image the ImageSource object stores. + true, if the created image source is used by multiple objects; otherwise, false. + + + + Creates an ImageSource object and sets its ImageSource.SvgImage property to the image passed as a parameter. + + An SVG image that the ImageSource object stores. + + + + Initializes a new instance of the class with specified settings. + + + + + For internal use. + + + + + Disposes of the ImageSource.Image object and sets the ImageSource.SvgImage property to null. + + + + + Determines whether the specified object is equal to the current ImageSource object. + + The object to compare with the current object. + true, if the specified object is equal to the current object; otherwise, false. + + + + Creates an ImageSource object and specifies its ImageSource.SvgImage or ImageSource.Image property depending on the image stored in the specified file. + + A file name to be used to get an image for the created ImageSource object. + An ImageSource object that stores the image from the specified file. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets floating-point width and height of the image the ImageSource object stores. + + true to use the original image resolution; otherwise false. + An object that provides the floating-point width and height of the image the ImageSource object stores. + + + + Returns an image. + + The image the ImageSource object stores. + + + + Indicates whether the ImageSource object stores an image. + + true, if both the ImageSource.SvgImage and ImageSource.Image properties are not specified; otherwise, false. + + + + Indicates whether the specified ImageSource object stores an image. + + An ImageSource object to be tested. + true, if the specified ImageSource object is null or its ImageSource.SvgImage and ImageSource.Image properties are not specified; otherwise, false. + + + + Returns an SVG image. + + An SVG image the ImageSource object stores. + + + + Specifies how an image is positioned within an image control. + + + + + The image is placed in the upper-left corner of the image control. The image is clipped if it’s larger than the image control which contains it. + + + + + The image within the image control is stretched or shrunk, as appropriate, to fit the size of the image control. + + + + + The image is sized proportionally (without clipping), so that it best fits the image control. If the height and width ratio of the image control is the same as the image’s ratio it will be resized to exactly fit into the image control. Otherwise, the closest fitting side (height or width) of the image will be sized to the control. The other side (height or width) of the image will be sized proportionally (leaving empty space). + + + + + Represents a page’s watermark. + + + + + Initializes a new instance of the class with the default settings. + + + + + Disposes of the object. + + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets or sets the font of the PageWatermark. + + The font of the PageWatermark. + + + + Gets or sets the foreground color of the ‘s text. + + A object representing the foreground color of the text. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + For internal use. + + A object specifying the watermark’s picture. + + + + Gets or sets the position of the ‘s picture. + + A enumeration value specifying how a picture is aligned on the document page. + + + + Specifies whether a picture watermark should be printed behind or in front of page content. + + The watermark position on a page. + + + + Gets or sets the image of the PageWatermark. + + The watermark image. + + + + Gets or sets a value indicating if a ‘s picture should be tiled. + + true to tile a watermark’s picture; otherwise, false. + + + + Gets or sets the transparency of the watermark’s image. + + An integer value specifying the images’s transparency. It should be between 0 and 255, inclusive. + + + + Gets or sets the mode in which a picture is displayed. + + An enumeration value specifying how the picture should be displayed. + + + + Gets or sets a ‘s text. + + A specifying the text of a watermark. + + + + Gets or sets the incline of the ‘s text. + + A enumeration value representing the text incline. + + + + Specifies whether a text watermark should be printed behind or in front of page content. + + The watermark position on a page. + + + + Gets or sets the transparency of the ‘s text. + + The transparency of the text. The value should be between 0 (opaque) and 255 (transparent). + + + + A document’s watermark. + + + + + Initializes a new instance of the class. + + + + + Duplicates the properties of the specified watermark object into the current instance of the class. + + A object whose properties are to be copied. + + + + Determines whether the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the unique identifier of a watermark + + A watermark unique identifier. + + + + For internal use. + + An integer value. + An integer value. + A Boolean value. + + + + Gets or sets the range of pages which contain a watermark. + + A specifying the range of pages which contain a watermark. + + + + Loads a watermark’s settings from the specified stream. + + A object from which the watermark’s settings are read. + + + + Loads a watermark’s settings from the specified XML file. + + A value specifying the XML file from which watermark settings are read. + + + + Saves the current watermark to the specified stream. + + A descendant to which the watermark is written. + + + + Saves the current watermark to an XML file. + + A specifying the path to the file in which the watermark will be stored. If an empty string is specified, an exception is raised. + + + + A collection of watermarks. + + + + + Lists values that specify a watermark position on a page. + + + + + Provides the base functionality for fields whose content can be edited in Print Preview. + + + + + Gets a visual brick used to render an editing field in Print Preview. + + A object used to render an editing field. + + + + Specifies the current value of an editing field. + + An object that specifies the current field value. + + + + Returns the location and size of an editing field. + + A structure specifying the editing field’s dimensions and location. + + + + Returns the current value of an editing field. + + A <T> object that specifies the current field value. + + + + Returns a document page on which an editing field is located. + + A object containing information about a document page. + + + + Specifies the unique identifier of an editing field. + + A string that specifies the editing field’s ID. + + + + Gets the index of the page on which an editing field is located. + + An integer value which specifies the page index. + + + + Specifies whether an editing field’s content can be customized in Print Preview. + + true, if a field cannot be edited in Print Preview; otherwise, false. + + + + The collection of fields whose content can be edited in Print Preview. + + + + + Attempts to obtain an editing field corresponding to the specified brick. + + A brick for which an editing field should be obtained. + An editing field corresponding to the specified brick. + true, if an editing field has been obtained; otherwise, false. + + + + Specifies editors that can be used for changing control content in Print Preview. + + + + + An editor with a mask for entering date-time values. + + + + + An editor with a mask for entering real values. + + + + + An editor with a mask for entering positive real values. + + + + + An editor that allows end-users to specify an image. + + + + + An editor that allows end-users to specify an image and/or draw something (e.g., a signature). + + + + + An editor with a mask for entering integer values. + + + + + An editor with a mask for entering positive integer values. + + + + + An editor with a mask for entering Latin letters only. + + + + + An editor with a mask for entering letters only. + + + + + An editor with a mask for entering lowercase letters only (entered characters are converted to lowercase). + + + + + An editor with a mask for entering uppercase letters only (entered characters are converted to uppercase). + + + + + An editor that allows end-users to draw a signature. + + + + + Provides data for the PrintingSystemBase.EditingFieldChanged event. + + + + + Create a new instance of the class with the specified editing field. + + An whose value has been changed. This value is assigned to the EditingFieldEventArgs.EditingField property. + + + + Gets an editing field whose value has been changed. + + An whose value has been changed. + + + + Represents different settings used to specify exporting parameters when a document is exported and sent via e-mail from the Print Preview. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the collection of email recipients. + + A class descendant. + + + + Appends a specified recipient to the end of the EmailOptions.AdditionalRecipients collection. + + A to add to the collection. + + + + Copies all the settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the text which is appended to an e-mail as its body, when a document is exported and sent via e-mail from its Print Preview. + + A which represents the e-mail body. + + + + Inserts a to the EmailOptions.AdditionalRecipients collection at the specified position. + + A value that specifies the position to insert a recipient. + A to insert to the EmailOptions.AdditionalRecipients collection. + + + + Gets or sets the text which is used as an e-mail’s recipient address, when a document is exported and sent via e-mail from its Print Preview. + + A which represents the e-mail recipient address. + + + + Gets or sets the prefix appended to the EmailOptions.RecipientAddress property value. + + A value. + + + + Gets or sets the text which is used as an e-mail’s recipient name, when a document is exported and sent via e-mail from its Print Preview. + + A which represents the e-mail recipient name. + + + + Gets or sets the text which is used as an e-mail’s subject, when a document is exported and sent via e-mail from its Print Preview. + + A which represents the e-mail subject. + + + + For internal use. Intended to create indivisible brick groups. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Empty”. + + + + Includes a brick specified via the parameter in the layout rectangle of the previously created . + + The brick included in the layout rectangle of the previously created . + + + + Lists the types of encoding to be used when a document is exported to a Text-based format. + + + + + A document is exported using the ASCII (7-bit) character set. + + + + + A document is exported using the UTF-16 format with the big-endian byte order. + + + + + A document is exported using the system’s current ANSI code page. + + + + + A document is exported using the UTF-16 format with the little-endian byte order. + + + + + A document is exported using the UTF-32 format with the little-endian byte order. + + + + + A document is exported using the UTF-7 format. + + + + + A document is exported using the UTF-8 format. + + + + + Provides data for the ExceptionEventArgs.Exception event. + + + + + Initializes a new instance of the class with the specified settings. + + A object. + + + + Provides access to the exception. + + A object, representing errors that occur during application execution. + + + + Specifies whether or not the corresponding event was handled. + + true if the exception was handled; otherwise, false. + + + + A method that will handle the ExceptionEventArgs.Exception event. + + The event sender. + An object that contains data related to the event. + + + + Contains classes which are used to implement exporting in the XtraPrinting library. + + + + + For internal use. + + + + + For internal use. Initializes a new instance of the class with the specified settings. + + A object. + A structure. + An object implementing the interface. + + + + Gets or sets a rectangle object specifying the height, width and location of the brick. + + A object representing a rectangular region by its height, width and location. + + + + Gets or sets a rectangle object specifying the height, width and location of the brick. + + A object representing a rectangular region by its height, width and location. + + + + Gets or sets the height of the brick. + + An integer value representing the height of the brick. + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + Gets the original bounds of the brick view data. + + A value. + + + + Gets the original bounds of the brick view data. + + A value. + + + + Gets or sets the instance used to render a brick in an appropriate format. + + A instance to render a brick. + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + Gets or sets the width of the brick. + + An integer value representing the width of the brick. + + + + For internal use. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + For internal use. Intended to support exporting bricks to some formats. + + A value. + + + + For internal use. Specifies the format settings that are applied to a document when it is exported to XLS format. + + + + + For internal use. Intended to support exporting bricks to some formats. + + + + + Contains internal classes that are required to support scripting in XtraReports. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + Lists the values that specify the available export formats. + + + + + The CSV export format. + + + + + The DOCX export format. + + + + + The HTML export format. + + + + + The image export format. + + + + + The MHT export format. + + + + + The PDF export format. + + + + + The PRNX export format. + For internal use only. + + + + + The RTF export format. + + + + + The TXT export format. + + + + + The XLS export format. + + + + + The XLSX export format. + + + + + The XPS export format. + + + + + Specifies the export options items which are displayed when an end-user exports a document from its Print Preview. + + + + + The DocxExportOptions.ExportMode property of the DOCX export options. + + + + + The FormattedTextExportOptions.ExportWatermarks property of the DOCX export options. + + + + + The DocxExportOptions.KeepRowHeight property of the DOCX export options. + + + + + The FormattedTextExportOptions.PageRange property of the DOCX export options. + + + + + The DocxExportOptions.TableLayout property of the DOCX export options. + + + + + The HtmlExportOptionsBase.CharacterSet property of the HTML export options. + + + + + The HtmlExportOptionsBase.EmbedImagesInHTML property of the HTML export options. + + + + + The HtmlExportOptionsBase.ExportMode property of the HTML export options. + + + + + The HtmlExportOptionsBase.ExportWatermarks property of the HTML export options. + + + + + The HtmlExportOptionsBase.PageBorderColor property of the HTML export options. + + + + + The HtmlExportOptionsBase.PageBorderWidth property of the HTML export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the HTML export options. + + + + + The HtmlExportOptionsBase.RemoveSecondarySymbols property of the HTML export options. + + + + + The HtmlExportOptionsBase.TableLayout property of the HTML export options. + + + + + The HtmlExportOptionsBase.Title property of the HTML export options. + + + + + The ImageExportOptions.ExportMode property of the Image export options. + + + + + The ImageExportOptions.Format property of the Image export options. + + + + + The ImageExportOptions.PageBorderColor property of the Image export options. + + + + + The ImageExportOptions.PageBorderWidth property of the Image export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the Image export options. + + + + + The ImageExportOptions.Resolution property of the Image export options. + + + + + The NativeFormatOptions.Compressed property of the native format Save options. + + + + + The PdfExportOptions.PdfACompatibility property of the PDF export options. + + + + + For internal use. + + + + + The PdfExportOptions.ConvertImagesToJpeg property of the PDF export options. + + + + + The PdfDocumentOptions.Application property of the PDF export options. + + + + + The PdfDocumentOptions.Author property of the PDF export options. + + + + + The PdfDocumentOptions.Keywords property of the PDF export options. + + + + + The PdfDocumentOptions.Subject property of the PDF export options. + + + + + The PdfDocumentOptions.Title property of the PDF export options. + + + + + The PdfExportOptions.ExportEditingFieldsToAcroForms property of the PDF export options. + + + + + The PdfExportOptions.ImageQuality property of the PDF export options. + + + + + The PdfExportOptions.NeverEmbeddedFonts property of the PDF export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the PDF export options. + + + + + The PdfExportOptions.PasswordSecurityOptions property of the PDF export options. + + + + + The PdfExportOptions.ShowPrintDialogOnOpen property of the PDF export options. + + + + + The PdfExportOptions.SignatureOptions property of the PDF export options. + + + + + The RtfExportOptions.ExportMode property of the RTF export options. + + + + + The FormattedTextExportOptions.ExportWatermarks property of the RTF export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the RTF export options. + + + + + The TextExportOptionsBase.Encoding property of the Text export options. + + + + + The TextExportOptionsBase.TextExportMode property of the Text export options. + + + + + The TextExportOptionsBase.QuoteStringsWithSeparators property of the Text export options. + + + + + The TextExportOptionsBase.Separator property of the Text export options. + + + + + The XlExportOptionsBase.ExportHyperlinks property of the XLS export options. + + + + + The XlsExportOptions.ExportMode property of the XLS export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the XLS export options. + + + + + The XlExportOptionsBase.RawDataMode property of the XLS export options. + + + + + The XlExportOptionsBase.SheetName property of the XLS export options. + + + + + The XlExportOptionsBase.ShowGridLines property of the XLS export options. + + + + + For internal use. + + + + + The XlsxExportOptions.ExportMode property of the XLSX export options. + + + + + The PageByPageExportOptionsBase.PageRange property of the XLSX export options. + + + + + The XpsExportOptions.Compression property of the XPS export options. + + + + + + + The XpsDocumentOptions.Category property of the XPS export options. + + + + + + + The XpsDocumentOptions.Creator property of the XPS export options. + + + + + + + The XpsDocumentOptions.Description property of the XPS export options. + + + + + + + The XpsDocumentOptions.Keywords property of the XPS export options. + + + + + + + The XpsDocumentOptions.Subject property of the XPS export options. + + + + + + + The XpsDocumentOptions.Title property of the XPS export options. + + + + + + + The XpsDocumentOptions.Version property of the XPS export options. + + + + + + + The PageByPageExportOptionsBase.PageRange property of the XPS export options. + + + + + + + Stores the document export options for different export formats. + + + + + Initializes a new instance of the class with default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets the settings used to specify exporting parameters when a document is exported to CSV format. + + A object which contains CSV export settings. + + + + Gets the settings used to specify exporting parameters when a document is exported to DOCX format. + + A object. + + + + Gets the settings used to specify exporting parameters when a document is sent by e-mail in Print Preview. + + Email export options. + + + + Gets the current visibility of the specified export option in the Print Preview. + + An enumeration value which specifies the export option whose visibility state is to be determined. + true if the specified export option is visible; otherwise, false. + + + + Gets the settings used to specify exporting parameters when a document is exported to HTML format. + + A object which contains HTML export settings. + + + + Gets the settings used to specify exporting parameters when a document is exported to image. + + A object which contains Image export settings. + + + + Provides access to an object that contains options which define how a document is exported to a mail message. + + A value. + + + + Gets the settings used to specify exporting parameters when a document is exported to MHT format. + + A object which contains MHT export settings. + + + + Provides access to the object, which contains settings for saving the PrintingSystem document in native format. + + A class instance, containing native format save settings. + + + + Gets the settings used to specify exporting parameters when a document is exported to PDF format. + + A object which contains PDF export settings. + + + + Gets the settings used to specify how a document is exported from the Print Preview. + + A object which contains Print Preview export settings. + + + + Loads export options from the specified stream. + + A object from which the export options are read. + + + + Loads export options from the specified XML file. + + A value specifying the XML file from which export options are read. + + + + Gets the settings used to specify exporting parameters when a document is exported to RTF format. + + A object which contains RTF export settings. + + + + Saves the current export options to the specified stream. + + A descendant to which the export options are written. + + + + Saves the current export options to an XML file. + + A specifying the path to the file in which the export options will be stored. If an empty string is specified, an exception is raised. + + + + Changes the visibility of the specified export options in the Print Preview. + + An array of enumeration values specifying the export options whose visibility needs to be changed. + true to make the export options visible; otherwise, false. + + + + Changes the visibility of the specified export option in the Print Preview (only for desktop platforms). + + An enumeration value which specifies the export option whose visibility needs to be changed. + true to make the export option visible; otherwise, false. + + + + Gets the settings used to specify exporting parameters when a document is exported to text. + + A object which contains Text export settings. + + + + Gets the settings used to specify exporting parameters when a document is exported to XLS format. + + An object which contains XLS export settings. + + + + Gets the settings used to specify export parameters when a document is exported to XLSX format. + + An object which contains XLSX export settings. + + + + Represents the base class for objects which define specific export options. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + The base for classes that provide options for export to RTF and DOCX formats. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies the settings from the specified object to the current object. + + An object whose settings are assigned to the current object. + + + + Specifies whether or not the header and footer contents should be displayed on the first page of the final document. + + true, to display the header and footer on the first page; otherwise, false. + + + + Specifies whether or not page breaks should be included in the resulting file when a document is exported to RTF/DOCX. + + true, to include page breaks in the resulting file; otherwise, false. + + + + Specifies whether or not watermarks should be included in the resulting file. + + true, to include watermarks; otherwise, false. + + + + Specifies whether the height of table cells in a resulting document should have fixed values, or adding a new line of text to a cell’s content should increase the row height. + + true, to make the row height unaffected by adding new content to a cell; otherwise, false. + + + + Specifies the range of pages to be exported. + + A value, specifying the range of pages. + + + + The checkbox glyph styles enumeration. + + + + + The Heart checkbox glyph style + + + + + The RadioButton checkbox glyph style + + + + + The Smiley checkbox glyph style + + + + + The StandardBox1 checkbox glyph style + + + + + The StandardBox2 checkbox glyph style + + + + + The Star checkbox glyph style + + + + + The Thumb checkbox glyph style + + + + + The Toggle checkbox glyph style + + + + + The YesNo checkbox glyph style + + + + + The YesNoBox checkbox glyph style + + + + + The YesNoSolidBox checkbox glyph style + + + + + Lists the available HTML export modes. + + + + + A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single HTML file. + + + + + A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting HTML file only once, at the beginning and at the end of the document. + + + + + A document is exported to a single file, page-by-page. In this mode, all pages are exported one under another, separated by page borders (which are specified by the HtmlExportOptionsBase.PageBorderWidth and HtmlExportOptionsBase.PageBorderColor properties). + + + + + Contains options which define how a document is exported to HTML format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + true to remove secondary symbols; otherwise, false. This value is assigned to the HtmlExportOptionsBase.RemoveSecondarySymbols property. + + + + Initializes a new instance of the class with the specified encoding name and title. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + + + + Initializes a new instance of the class with the specified encoding name. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + + + + Represents the base class for objects which define export options specific to HTML and MHT formats. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether the JavaScript code can be placed in URLs in the resulting HTML document. + + true, to allow inserting the JavaScript code to URLs; otherwise, false. + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the encoding name used when exporting a document to HTML. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). + + + + Specifies whether or not images are embedded in HTML content. + + true to embed images in HTML; otherwise, false. + + + + Gets or sets a value indicating how a document is exported to HTML. + + An enumeration value which represents the HTML export mode. + + + + Specifies whether to export watermarks to HTML along with the rest of the document content. + + true to export watermarks to HTML; otherwise false. + + + + Specifies whether the style properties are written to the <head> section of an HTML document, or they are defined at the same place where a specific style is assigned in a document. + + true to define the style properties at the same place where a specific style is assigned in a document, otherwise false. + + + + Gets or sets the color of page borders when a document is exported to HTML page-by-page. + + A value which represents the page border color. + + + + Gets or sets the width (in pixels) of page borders when a document is exported to HTML page-by-page. + + An integer value which represents the page border width. + + + + Gets or sets the range of pages to be exported. + + A specifying the range of pages. + + + + Gets or sets a value indicating whether secondary symbols should be removed from the resulting HTML file, to reduce its size. + + true to remove secondary symbols; otherwise, false. + + + + Determines whether to use the table or non-table layout in the resulting HTML file. + + true, to use a table layout; otherwise, false. + + + + Gets or sets a title of the created HTML file + + A containing the name shown as the title of the created HTML file. + + + + Specifies whether or not the document navigation is implemented by using scripts. + + true to use standard HTML link references in document navigation; otherwise false. + + + + Lists the acceptable line directions for HTML export. + + + + + Specifies the default line direction when exported into HTML. + + + + + Specifies the horizontal line in HTML export. + + + + + Specifies the vertical line in HTML export. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + When implemented by a class, creates report elements (bricks) for a specific area. + + The name of the report area (section) for which elements should be created. + A graphical surface on which report elements will be drawn. + + + + If implemented by a class, finalizes the printing of the report. + + An object used to print a control. + An object which refers to a control. + + + + When implemented by a class, initializes a control for report creation. + + An object used to print a control. + An object which refers to a control. + + + + Provides basic report drawing functions. + + + + + If implemented by a class, gets and sets the default style for bricks. + + The default style for bricks. + + + + If implemented by a class, adds a brick to a report. + + The brick to be added to a report. + A RectangleF structure that specifies the location and size of the current brick. + The brick added to a report. + + + + If implemented by a class, raises the ModifierChanged event. + + + + + If implemented by a class, provides methods for handling commands in Print Preview. + + + + + Indicates whether or not the specified Printing System command can be handled. + + A enumeration value. + An object implementing the interface (typically, this is a instance). + true, if the command can be handled; otherwise, false. + + + + If implemented by a class, allows you to handle Printing System commands (listed in the enumeration). + + A enumeration value. + An array of values, specifying the command arguments. + An object implementing the interface (typically, this is a instance). + true, if the command has been handled; otherwise, false. + + + + For internal use. + + + + + For internal use. + + A descendant. + + + + Provides the essential functionality for document printing. + + + + + For internal use. + + A value. + + + + For internal use. + + + + + For internal use. + + A object. + + + + Provides the basic functionality to create documents that are ready to print. + + + + + If implemented by a class, initiates report generation. + + + + + If implemented by a class, creates a document from the link, so the document can be displayed or printed. + + A Boolean value. This value is ignored and has no effect on the document creation process. + + + + Provides access to a link’s printing system. + + An object implementing the interface. + + + + A visual brick containing an image. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class. + + A BorderSide enumeration value which specifies the borders displayed around the . + A float value which specifies the border width of the , measured in pixels. + A object which specifies the border color of the . + A object which specifies the background color of the current . + + + + Initializes a new instance of the class with the specified brick style. + + A object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Image”. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Disposes of the object. + + + + + Gets or sets a value indicating whether it is necessary to dispose of an image assigned to the ImageBrick.ImageSource property, when disposing the object. + + true to dispose of the image; otherwise, false. + + + + For internal use. + + + + + Gets or sets the path to the image to display in the . + + A which represents the path to an image. + + + + Defines the image displayed within the brick. + + The image displayed within the brick. + + + + Gets or sets the alignment of the image displayed within the current brick. + + One of the values. + + + + Gets or sets the value used to support serialization of the ImageBrick.ImageSource property. + + A DevExpress.XtraPrinting.Native.ImageEntry object. + + + + Defines the image displayed within the brick. + + The image displayed within a brick. + + + + Specifies the size mode for the . + + An enumeration value. + + + + Overrides the VisualBrick.Text property to hide it. + + A value. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Gets or sets whether to use the original image DPI (dots per inch) value when the image is rendered in a document. + + true, to use the image resolution; otherwise false. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + An editing field that allows end-users to change an image content in Print Preview. + + + + + Initializes a new instance of the ImageEditingField class. + + A visual brick used to draw an image in a document. + + + + Specifies the name of an editor used to change the image editing field’s value in Print Preview. + + A string that specifies the editor name. + + + + Overrides the EditingField.EditValue property. + + + + + The image alignment of the associated image brick. + + The image brick’s ImageBrick.ImageAlignment option value. + + + + The size mode of the associated image brick. + + The image brick’s ImageBrick.SizeMode option value. + + + + Specifies the image that the associated image brick currently displays. + + An image brick’s current image. + + + + Stores the image that the associated image brick had when the ImageEditingField object was created. + + The image that the image brick had at the moment when the ImageEditingField was created. + + + + Lists the available image export modes. + + + + + Exports each document page to a separate image (with the image file name indicating the page number). + The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image. + + + + + Exports the document to a single image without indicating the borders of individual pages. + The document’s page headers and footers, and the top and bottom margins are repeated only once - at the beginning and end of the resulting image. + When this export mode is used, the ImageExportOptions.PageRange property is ignored. + + + + + The document is exported to a single image with borders drawn around each page. + The document’s page headers and footers, and top and bottom margins appear on every page. + The border settings are specified by the ImageExportOptions.PageBorderWidth and ImageExportOptions.PageBorderColor properties. + + + + + Contains options which define how a document is exported to an image. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified image format. + + An object. This value is assigned to the ImageExportOptions.Format property. + + + + Copies the settings from the specified object to the current object. + + An object whose settings are assigned to the current object. + + + + Specifies whether document pages are exported to a single or multiple images. + + An enumeration value. + + + + Specifies the image format for exporting a document. + + An object that defines the image format. + + + + For internal use. + + + + + + Specifies the page border color when a document is exported to a single image page-by-page. + + A value. + + + + Specifies the page border width (in pixels) when a document is exported to a single image page-by-page. + + An integer value, specifying the page border width (in pixels). + + + + Specifies the range of pages to be exported. + + A value, specifying the range of pages. The ranges are defined using hyphens and separated by commas. For example: “1,3,5-12”. + + + + Specifies the image resolution (in DPI). + + An integer value, specifying the image resolution (in DPI). + + + + Specifies whether a report is printed with a white or transparent background when the XtraReport.PageColor (BrickGraphics.PageBackColor) property is set to transparent. + + true, to retain the transparency in a published report; otherwise, false. + + + + Specifies the quality of text rendering in images (especially in images having small DPI values and a transparent background). + + A enumeration value. + + + + Provides the basic functionality for the component. + + + + + For internal use. + + + + + Specifies the Printing System used to create and print a document for the link associated with the . + + A descendant. + + + + Provides the base functionality of the XtraPrinting Library. + + + + + Occurs after certain properties of the object have been changed. + + + + + For internal use. If implemented by a class, gets or sets the number of virtual pages which should be placed on one physical page, so their total width is the same as the width of a physical page. + + An integer value which represents the number of pages. + + + + Occurs before certain properties of the object are changed. + + + + + If implemented by a class, creates a brick by its type name. + + A specifying the type name of the brick to be created. + An object implementing the interface. + + + + If implemented by a class, creates an image brick. + + An object implementing the DevExpress.XtraPrinting.IImageBrick interface. + + + + If implemented by a class, creates a panel brick. + + An object implementing the DevExpress.XtraPrinting.IPanelBrick interface. + + + + If implemented by a class, creates a progress bar brick. + + An object implementing the DevExpress.XtraPrinting.IPanelBrick interface. + + + + If implemented by a class, creates a rich text brick. + + An object implementing the DevExpress.XtraPrinting.IRichTextBrick interface. + + + + If implemented by a class, creates a text brick. + + An object implementing the DevExpress.XtraPrinting.IPanelBrick interface. + + + + For internal use. + + + + + For internal use. If implemented by a class, contains a collection of images to be cached when creating a document. + + A DevExpress.XtraPrinting.Native.ImagesContainer object. + + + + If implemented by a class, inserts a page break at a specified position. + + A value which specifies the position to insert a page break. + + + + If implemented by a class, changes the visibility of the specified printing system command. + + A object specifying the command whose visibility needs to be changed. + One of the enumeration values specifying a new visibility state for the command. + + + + Identifies the XtraPrinting Library version. + + A text string representing XtraPrinting Library‘s version info. + + + + For internal use. Provides information about the Printing System. + + + + + For internal use. + + + + + For internal use. + + A object. + + + + For internal use. + + + + + For internal use. + + A descendant. + + + + A visual brick that contains a rotated text. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets or sets the rotation angle of the text displayed within the brick. + + A value, specifying the text angle in degrees. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Label”. + + + + Specifies whether or not a brick’s height can be automatically changed based on the amount of its contents. + + true to enable automatic adjustment of a brick’s height; otherwise false. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Gets a value indicating whether text within a label brick is drawn vertically. + + true if the text is shown in a vertical mode; otherwise, false. + + + + A visual brick containing a line. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Line”. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Gets or sets the color of the line displayed in the current line brick. + + A object specifying the foreground color of the line. + + + + Gets or sets the line direction in HTML output. + + An enumeration value. + + + + Gets or sets the line direction. + + A enumeration value, which determines the current line direction. + + + + Gets or sets the style used for a dashed line. + + + + + Gets or sets the width of the line displayed in the line brick. + + An integer value representing the width of the line. + + + + Overrides the VisualBrick.Text property to hide it. + + A value. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + The base class for all printing links. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified printing system. + + A object which specifies the printing system used to draw the current link. This value is assigned to the LinkBase.PrintingSystemBase property. + + + + Initializes a new instance of the class with the specified container. + + An object implementing the interface which specifies the owner container of a class instance. + + + + Gets the current document creation status. + + A enumeration value. + + + + Adds a subreport to the specified band in the current report. + + A descendant. + A report band where the subreport shall be inserted. + A object which specifies the vertical offset of the subreport within the current report. + + + + Adds a subreport to the current report. + + A value which specifies the vertical offset of the subreport within the current report. + + + + Occurs after all sections of the document have been generated. + + + + + Occurs before any section of the document is generated. + + + + + Indicates whether or not the specified Printing System command can be handled. + + A enumeration value that specifies the command. + An object implementing the interface that specifies the print control (most typically, it is a class instance). + true if the command can be handled; otherwise, false. + + + + Removes all pages from the current document. + + + + + Occurs when a detail section of the document is being generated. + + + + + Occurs when a detail footer section of the document is being generated. + + + + + Occurs when a detail header section of the document is being generated. + + + + + Creates a report using the current PrintingSystem. + + + + + Creates a document from the link using the specified Printing System. + + A class instance, specifying the printing system of the link. + + + + Occurs when an inner page footer section of the document is being generated. + + + + + Occurs when an inner page header section of the document is being generated. + + + + + Occurs when a marginal page footer section of the document is being generated. + + + + + Occurs when a marginal page header section of the document is being generated. + + + + + Occurs when a report footer section of the document is being generated. + + + + + Occurs when a report header section of the document is being generated. + + + + + Gets or sets the paper size (measured in hundredths of an inch). + + A value that specifies the custom paper size (measured in hundredths of an inch). + + + + Enables the Header and Footer dialog used for editing a document page’s headers and footers. + + true if the Header and Footer dialog is enabled; otherwise false. + + + + Exports a document to the specified stream in CSV format using the defined CSV-specific options. + + A object to which the created CSV file should be sent. + A object which specifies the CSV export options to be applied when a document is exported. + + + + Exports a document to the specified stream in CSV format. + + A object to which the created CSV file should be sent. + + + + Exports a document to the specified file path in CSV format using the defined CSV-specific options. + + A which specifies the file name (including the full path) for the created CSV file. + A object which specifies the CSV export options to be applied when a document is exported. + + + + Exports a document to the specified file path in CSV format. + + A which specifies the file name (including the full path) for the created CSV file. + + + + Exports a document to the specified stream in DOCX format using the defined DOCX-specific options. + + A object to which the created DOCX file should be sent. + A object that specifies the DOCX export options to be applied when a document is exported. + + + + Exports a document to the specified stream in DOCX format. + + A object to which the created DOCX file should be sent. + + + + Exports a document to the specified file path in DOCX format using the specified DOCX-specific options. + + A value that specifies the file name (including the full path) for the created DOCX file. + A object that specifies the DOCX export options to be applied when a document is exported. + + + + Exports a document to the specified file path in DOCX format. + + A value that specifies the file name (including the full path) for the created DOCX file. + + + + Exports a document to the specified stream in HTML format using the defined HTML-specific options. + + A object to which the created HTML file should be sent. + A object which specifies the HTML export options to be applied when a document is exported. + + + + Exports a document to the specified stream in HTML format. + + A object to which the created HTML file should be sent. + + + + Exports a document to the specified file path in HTML format using the defined HTML-specific options. + + A which specifies the file name (including the full path) for the created HTML file. + An object which specifies the HTML export options to be applied when a document is exported. + + + + Exports a document to the specified file path in HTML format. + + A which specifies the file name (including the full path) for the created HTML file. + + + + Exports a document to the specified stream in Image format using the defined Image-specific options. + + A object to which the created Image file should be sent. + An object which specifies the Image export options to be applied when a document is exported. + + + + Exports a document to the specified stream in Image format. + + A object to which the created Image file should be sent. + + + + Exports a document to the specified file path in Image format using the defined Image-specific options. + + A which specifies the file name (including the full path) for the created Image file. + A object which specifies the Image export options to be applied when a document is exported. + + + + Exports a document to the specified file path in Image format. + + A which specifies the file name (including the full path) for the created Image file. + + + + Exports a document to the specified stream in MHT format using the defined MHT-specific options. + + A object to which the created MHT file should be sent. + An object which specifies the MHT export options to be applied when a document is exported. + + + + Exports a document to the specified stream in MHT format. + + A object to which the created MHT file should be sent. + + + + Exports a document to the specified file path in MHT format using the defined MHT-specific options. + + A which specifies the file name (including the full path) for the created MHT file. + An object which specifies the MHT export options to be applied when a document is exported. + + + + Exports a document to the specified file path in MHT format. + + A which specifies the file name (including the full path) for the created MHT file. + + + + Exports a document to the specified stream in PDF format using the defined PDF-specific options. + + A object to which the created PDF file should be sent. + A object which specifies the PDF export options to be applied when a document is exported. + + + + Exports a document to the specified stream in PDF format. + + A object to which the created PDF file should be sent. + + + + Exports a document to the specified file path in PDF format using the defined PDF-specific options. + + A which specifies the file name (including the full path) for the created PDF file. + A object which specifies the PDF export options to be applied when a document is exported. + + + + Exports a document to the specified file path in PDF format. + + A which specifies the file name (including the full path) for the created PDF file. + + + + Exports a document to the specified stream in RTF format using the defined RTF-specific options. + + A to which the created RTF file should be sent. + An object, representing options, which define how a document is exported to RTF format. + + + + Exports a document to the specified stream in RTF format. + + A object to which the created RTF file should be sent. + + + + Exports a document to the specified file path in RTF format using the defined RTF-specific options. + + A , which specifies the file name (including the full path) for the created RTF file. + An object, representing options, which define how a document is exported to RTF format. + + + + Exports a document to the specified file path in RTF format. + + A which specifies the file name (including the full path) for the created RTF file. + + + + Exports a document to the specified stream in Text format using the defined Text-specific options. + + A object to which the created Text file should be sent. + A object which specifies the Text export options to be applied when a document is exported. + + + + Exports a document to the specified stream in Text format. + + A object to which the created Text file should be sent. + + + + Exports a document to the specified file path in Text format using the defined Text-specific options. + + A which specifies the file name (including the full path) for the created Text file. + A object which specifies the Text export options to be applied when a document is exported. + + + + Exports a document to the specified file path in Text format. + + A which specifies the file name (including the full path) for the created Text file. + + + + Exports a report to the specified stream in XLS format using the defined XLS-specific options. + + A object to which the created XLS file should be sent. + An object, specifying the XLS export options to be applied when a report is exported. + + + + Exports a report to the specified stream in XLS format. + + A object to which the created XLS file should be sent. + + + + Exports a report to the specified file path in XLS format using the defined XLS-specific options. + + A value, specifying the file name (including the full path) for the created XLS file. + An object, specifying the XLS export options to be applied when a report is exported. + + + + Exports a report to the specified file path in XLS format. + + A value, specifying the file name (including the full path) for the created XLS file. + + + + Exports a report to the specified stream in XLSX format using the defined XLSX-specific options. + + A object to which the created XLSX file should be sent. + An object, specifying the XLSX export options to be applied when a report is exported. + + + + Exports a report to the specified stream in XLSX format. + + A object to which the created XLSX file should be sent. + + + + Exports a report to the specified file path in XLSX format using the defined XLSX-specific options. + + A value, specifying the file name (including the full path) for the created XLSX file. + An object, specifying the XLSX export options to be applied when a report is exported. + + + + Exports a report to the specified file path in XLSX format. + + A value, specifying the file name (including the full path) for the created XLSX file. + + + + Handles the specified Printing System command. + + A enumeration value which specifies the command to be handled. + A collection of objects representing the parameters to be passed to the handled command. + An object implementing the interface (most typically, it is the class instance). + true if the command has been handled by a link; otherwise, false. + + + + Gets or sets a value indicating whether the page orientation is landscape. + + true if the page orientation is landscape; otherwise, false. + + + + Gets or sets the margins of a report page (measured in hundredths of an inch). + + + + + Specifies the minimum printer margin values. + + + + + For internal use. + + A descendant. + + + + Gets or sets the object used to fill the document’s area that is occupied by the page header and page footer. + + A used to fill the document’s area that is occupied by the page header and page footer. + + + + Gets or sets the type of paper for the document. + + + + + Gets or sets the name of the custom paper which is used in the printer that the document is going to be printed on. + + A specifying the name of the paper. + + + + Gets the type of the object to be printed. + + A object representing the type of object to be printed. + + + + Gets or sets the Printing System used to create and print a document for this link. + + A object which specifies the Printing System used to create and print a document. + + + + Loads a Page Header/Footer dialog’s settings from the specified stream. + + A object from which the header/footer’s settings are read. + + + + Loads a Page Header/Footer dialog’s settings from the specified XML file. + + A value specifying the XML file from which header/footer settings are read. + + + + Specifies the orientation of the document’s content. + + true, if the right-to-left layout is enabled; otherwise, false. + + + + Gets or sets the RTF text, which will be printed as a Report Footer. + + A containing RTF text. + + + + Gets or sets the RTF text, which will be printed as a Report Header. + + A containing RTF text. + + + + Saves the Page Header/Footer dialog’s settings to the specified stream. + + A descendant to which the header/footer is written. + + + + Saves the Page Header/Footer dialog’s settings to an XML file. + + A specifying the path to the file in which the header/footer will be stored. If an empty string is specified, an exception is raised. + + + + Sets the object to be printed by this link. + + A object implementing the interface. + + + + Gets or sets report areas that should be skipped. + + Report areas that should be skipped. + + + + Gets or sets a value indicating whether content bricks, which are outside the right page margin, should be split across pages, or moved in their entirety to the next page. + + A enumeration value, which specifies the way of splitting method of content bricks in the vertical direction. + + + + A collection of objects. + + + + + Adds the specified object to the collection. + + A object to add to the collection. + An integer value indicating the position into which the new element was inserted. + + + + Adds the elements of a to the end of the . + + An array of objects to be added to the end of the . + + + + Determines whether the specified object is a member of the collection. + + The object to locate in the collection. + true if the link is a member of the collection; otherwise, false. + + + + Copies the elements of a from a compatible one-dimensional collection. + + An object which the links will be copied from. + + + + Returns the zero-based index of the specified link in the collection. + + The object to locate in the collection. + An integer value representing the position of the specified link in the collection. + + + + Inserts the specified object into the collection at the specified position. + + The zero-based index at which the link should be inserted. + The object to insert into the collection. + + + + Provides indexed access to individual items in the collection. + + A zero-based integer, specifying the desired item’s position within the collection. If it is negative or exceeds the last available index, a is thrown. + A class descendant representing the link at the specified position. + + + + Removes the specified object from the collection. + + The object to remove from the collection of links. + + + + Contains options which define how a document is exported to a mail message. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + true to remove secondary symbols; otherwise, false. This value is assigned to the HtmlExportOptionsBase.RemoveSecondarySymbols property. + + + + Initializes a new instance of the class with the specified settings. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + + + + Initializes a new instance of the class with the specified settings. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + + + + Always returns false. + + Returns false. + + + + Overrides the corresponding property of the class to hide it. + + Always true. + + + + Overrides the corresponding property of the class to hide it. + + Always true. + + + + Provides data for the PrintingSystemBase.BeforeMarginsChange event. + + + + + Gets changed page margins. + + The changed page margin. + + + + Gets or sets the changed margin size in hundredths of an inch. + + The changed margin size in hundredths of an inch. + + + + A method that will handle the PrintingSystemBase.BeforeMarginsChange event of the class. + + The event source. + A object that contains data related to the event. + + + + Specifies page margin(s). + + + + + Specifies all report page margins. + + + + + Specifies the bottom report page margin. + + + + + Specifies the left report page margin. + + + + + Specifies no report page margin. + + + + + Specifies the right report page margin. + + + + + Specifies the top report page margin. + + + + + Contains options which define how a document is exported to MHT format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + true to remove secondary symbols; otherwise, false. This value is assigned to the HtmlExportOptionsBase.RemoveSecondarySymbols property. + + + + Initializes a new instance of the class with the specified encoding name and title. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + A containing the name shown as the title of the created HTML file. This value is assigned to the HtmlExportOptionsBase.Title property. + + + + Initializes a new instance of the class with the specified encoding name. + + A representing the encoding name set in the HTML file (e.g. “UTF-8”). This value is assigned to the HtmlExportOptionsBase.CharacterSet property. + + + + Overrides the HtmlExportOptionsBase.EmbedImagesInHTML property, to hide it. + + + + + Contains the class that provides various compatibility options. + + + + + Enables you to overcome possible issues related to document rendering after migrating to newer versions of XtraReports. + + + + + Enables you to display a non-modal Microsoft Outlook dialog before sending a report by email. + + true to display a non-modal dialog when sending a report by email; otherwise false. The default is false. + + + + Gets or sets whether to cache images in a document storage when a report document is generated. + + true (the default value), to cache images in a document storage when a report document is generated; otherwise, false. + + + + This property is obsolete (this member has become obsolete). + + + + + Enables you to prevent PDF drawing exceptions related to the GDI+ engine from being handled by the DevExpress export engine. + + true to avoid handling PDF drawing exceptions; otherwise false. The default is false. + + + + This property is obsolete (this member has become obsolete). + + + + + Specifies whether to use the GDI+ line break algorithm when a report is exported to PDF. + + true, to use the GDI+ line break algorithm; false, otherwise. + + + + Specifies whether or not to substitute missing fonts in the Rich Text when a report is exported to HTML. + + true, to automatically substitute fonts missing in the system; otherwise, false. + + + + Enables you to make the Pivot Grid width equal to the page width when setting the XtraReport.VerticalContentSplitting property to VerticalContentSplitting.Smart. + + true to make the Pivot Grid occupy the entire page width; otherwise false. The default is false. + + + + Contains options which define how a document is exported to the native Printing System file format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets a value indicating whether the resulting PRNX file should be compressed. + + true to compress the resulting PRNX file; otherwise, false. + + + + Gets or sets a value which indicates whether a Native Format Options window should be shown when an end-user saves a document from the Print Preview. + + true to show the Native Format Options window; otherwise, false. + + + + A single document page. + + + + + Adds the specified brick to the page. + + The brick to be added to the page. + + + + Assigns a new watermark to a page’s Page.Watermark property. + + A object which specifies a new watermark for a page. + + + + Gets the document which contains the page. + + A object representing the document containing the current page. + + + + Returns the size and location of the specified brick in the current page. + + A object representing the brick whose size and location should be returned. + A object specifying the width, height and location of the brick. + + + + For internal use. + + + + + Specifies the page’s identifier. + + An integer value specifying the page’s identifier. + + + + Gets the page index within the collection. + + The page index within the collection. + + + + Provides access to the inner bricks of . + + + + + Gets the margins value (measured in three hundredths of an inch) of the current page. + + A DevExpress.XtraPrinting.Native.MarginsF object which represents the margins (measured in 1/300 of an inch) of the current page. + + + + Gets or sets the page index within the page collection when the document is created. + + An integer, representing a page number in a document. + + + + Gets or sets the page count when the document is created. + + An integer, representing the number of pages in a document. + + + + Gets the size of the current page. + + A value. + + + + Gets or sets the type of paper for the page. + + A value that defines the paper kind. + + + + For internal use. + + + + + Gets or sets the scale factor (in fractions of 1), by which a page is scaled. + + A value, which represents the current scale factor. + + + + For internal use. + + + + + Provides access to the current watermark on this page. + + A object which represents the current watermark. + + + + Specifies the unique identifier of a watermark to be displayed on a page. + + A watermark unique identifier. + + + + Serves as the base for classes that specify information to be displayed in page header and page footer areas. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + An array of values, representing content strings. This value is assigned to the PageArea.Content property. + A value, which is used to draw the page area’s text. This value is assigned to the PageArea.Font property. + A enumeration value specifying the content alignment. This value is assigned to the PageArea.LineAlignment property. + + + + Provides access to a collection of strings, representing the content of a page header or page footer. + + A object, containing content strings. + + + + Gets or sets the font used to draw the page area’s text. + + An object that defines the text’s format, including font face, size, and style attributes. + + + + Gets or sets a value specifying which edge (top, center or bottom) of the page area its content should be aligned. + + A enumeration value specifying the content alignment. + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Represents the base class for objects which define specific export options for those export formats which support page-by-page export (HTML, MHT and PDF). + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the page range to be exported. + + A page range. + + + + Specifies the resolution (in DPI) used to rasterize vector images on export to the corresponding document format. + + The resolution (in DPI) used to rasterize vector images. + + + + Specifies whether or not vector images should be rasterized on export to the corresponding document format. + + true, to rasterize vector images; otherwise, false. + + + + For Internal use. Provides data for the PrintingSystemBase.AfterPagePrint event. + + + + + For internal use. + + + + + For internal use. + + + + + A method that handles all page events within the XtraPrinting Library. + + The event source. + A object that contains data related to the event. + + + + Represents the object that specifies information to be displayed in a page footer area. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + An array of values, representing content strings. This value is assigned to the PageArea.Content property. + A value, which is used to draw the page area’s text. This value is assigned to the PageArea.Font property. + A enumeration value specifying the content alignment. This value is assigned to the PageArea.LineAlignment property. + + + + Represents the object that specifies information to be displayed in a page header area. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + An array of values, representing content strings. This value is assigned to the PageArea.Content property. + A value, which is used to draw the page area’s text. This value is assigned to the PageArea.Font property. + A enumeration value specifying the content alignment. This value is assigned to the PageArea.LineAlignment property. + + + + Represents the object, containing information about the page header and page footer areas. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified page header and page footer. + + A object representing the page header. This value is assigned to the PageHeaderFooter.Header property. + A object representing the page footer. This value is assigned to the PageHeaderFooter.Footer property. + + + + Provides access to the page footer area. + + A object representing the page footer. + + + + Provides access to the page header area. + + A object representing the page header. + + + + Specifies whether or not the page margin is increased if its content does not fit. + + true to increase the page margin; otherwise, false. + + + + Returns the textual representation of the header/footer. + + Always . + + + + A visual brick within the page header or page footer section, containing an image. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class. + + A BorderSide enumeration value which specifies the borders displayed around the . + A float value which specifies the border width of the , measured in pixels. + A object which specifies the border color of the . + A object which specifies the background color of the current . + + + + Gets or sets the alignment of brick within the page layout rectangle. + + A enumeration, specifying the alignment. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “PageImage”. + + + + Specifies the alignment of an image. + + An enumeration value. + + + + Gets or sets the brick alignment related to the top of the parent area. + + A enumeration member, specifying the alignment. + + + + A visual brick which is displayed in the page header or page footer sections, and contains information specific to the current page. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value, specifying the brick’s border settings. + A value, specifying the border width. + A structure, specifying the border color. + A structure, specifying the background color. + A structure, specifying the foreground color. + + + + Gets or sets the alignment of brick within the page layout rectangle. + + A enumeration, specifying the alignment. + + + + Determines whether the current brick is resized in order to display the entire text of a brick. + + true, if brick width changes in order to display the entire brick text, otherwise, false. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “PageInfo”. + + + + Gets or sets the brick alignment related to the top of the parent area. + + A enumeration member, specifying the alignment. + + + + A service that allows the XRPageInfo control to display custom information. + + + + + Enables you to obtain and customize the text of the Page Info control. + + A object. + A descendant. + A value. + + + + The base for the class. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified visible borders, their width, color, and background and foreground colors. + + A enumeration value(s) which specifies the borders displayed around the brick. + A value which specifies the border width of the brick, measured in pixels. + A object which specifies the border color of the brick. + A object which specifies the background color of the brick. + A object which specifies the foreground color of the brick. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string containing the brick type information. + + A string, characterizing the brick’s type. Always returns “PageInfo”. + + + + Gets or sets a value indicating whether the page number should be changed according to reordering in the Pages collection. + + A enumeration member. + + + + Gets or sets the format string to display text information within the brick. + + A string, consisting of alternating fixed text and indexed placeholders. + + + + Gets or sets the type of information to be displayed within the . + + A enumeration member, indicating information type and its representation. + + + + Gets or sets the initial value of a page counter. + + An integer value representing an initial number for pagination. + + + + Gets or sets the text to be displayed within the current brick. + + A representing the text to be displayed within the brick. + + + + The base for the and classes. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value. + A structure. + A structure. + A structure. + A structure. + + + + Initializes a new instance of the class with specified settings. + + + + + For internal use. Initializes a new instance of the class with the specified brick owner. + + An object implementing the IBrickOwner interface. + + + + Specifies the format string to display text information within the brick. + + A value, consisting of alternating fixed text and indexed placeholders. + + + + Specifies the type of information to be displayed within the brick. + + A enumeration value, specifying information type and its representation. + + + + Specifies the initial value of a page counter. + + An integer value, specifying an initial number for pagination. + + + + For internal use. Specifies the format settings that are applied to a document when it is exported to XLS format. + + A enumeration value. + + + + A collection of objects. + + + + + Initializes a new instance of the class with the specified settings. + + A object which specifies the document which contains this page list. The created is assigned to the Document.Pages property of the specified document. + A collection of objects that specify document pages. + + + + Initializes a new instance of the class with the specified document. + + A object which specifies the document which contains this page list. The created is assigned to the Document.Pages property of the specified document. + + + + Adds the specified object to the collection. + + A object to add to the collection. + + + + Appends an array of pages to the collection. + + An array of the objects to append to the collection. + + + + Clears the collection. + + + + + Indicates whether the collection contains the specified item. + + A object to locate in the collection. + true, if the collection contains the specified item; otherwise, false. + + + + Copies all s from this collection to a compatible target one-dimensional array, starting from the specific index of the target array. + + An array to which all items should be copied. + A zero-based index starting from which copied elements should be arranged in the target array. + + + + Counts the number of items in the collection. + + An integer value. + + + + Gets the first page within the collection. + + An object of the class. + + + + Obtains the collection’s enumerator. + + An object implementing the interface. + + + + For internal use. + + + + + Returns the zero-based index of the specified page in the collection. + + The object to locate in the collection. + An integer value representing the position of the specified page in the collection. + + + + Inserts the specified page into the list at the specified position. + + An integer value which represents the zero-based index at which the page should be inserted. + A object to insert into the list. + + + + Gets or sets an item within the collection at a specific index. + + The zero-based index of the item to get or set. + An item at a specific index. + + + + Gets the last page in the collection. + + An object of the class. + + + + Removes the specified page from the collection. + + A object to remove from the collection. + true, if the specified page has been successfully removed; false, if the page is not found in the collection. + + + + Removes the collection’s item at the specified position. + + An integer value. + + + + Copies the elements of the to a new array of objects. + + An array of objects containing the copies of the elements of the . + + + + Tries to get a page by the specified index. + + An integer value that specifies the zero-based index of the page. + An object that specifies the page. + true, if the page has been found; otherwise, false. + + + + Provides data for the PrintingSystemBase.BeforePagePaint and PrintingSystemBase.AfterPagePaint events. + + + + + Provides access to the graphics object on which the PagePaintEventArgs.Page is painted. + + An object implementing the interface. + + + + Provides access to the page for which the PrintingSystemBase.BeforePagePaint or PrintingSystemBase.AfterPagePaint event is raised. + + A object. + + + + Returns the bounds (size and location) of the page for which the PrintingSystemBase.BeforePagePaint or PrintingSystemBase.AfterPagePaint event is raised. + + A object. + + + + Represents a method that will handle the PrintingSystemBase.BeforePagePaint and PrintingSystemBase.AfterPagePaint events. + + The event source. This parameter identifies the which raised the event. + A object which contains event data. + + + + Enables you to override the default printer settings in your application. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies a custom letter paper size. + + + + + Provides access to the page settings defined for the system’s default printer. + + A object. + + + + Provides access to the page settings defined for the system’s default printer. + + A object. + + + + For internal use. + + + + + Returns the minimum page margins supported by the specified page settings. + + A object. + + + + For internal use. + + + + + Specifies an instance of the class. + + The instance of the class. + + + + Indicates whether or not there are any printers installed on the machine. + + true, if there is at least one printer installed on the machine; otherwise, false. + + + + Specifies the default printer settings. + + A object. + A object. + + + + For internal use. + + + + + For internal use. + + + + + Assigns the specified printer name to the default printer settings (if such a printer is installed on the machine). + + A object. + A value, specifying the printer name. + + + + A visual brick comprised of rows and columns. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the alignment of brick within the page layout rectangle. + + A enumeration, specifying the alignment. + + + + Gets a collection of bricks which are contained in this . + + A object, which contains bricks belonging to this table brick. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “PageTable”. + + + + Gets or sets the brick alignment related to the top of the parent area. + + A enumeration member, specifying the alignment. + + + + Gets the collection of rows owned by the object. + + A object representing the collection of rows. + + + + Refreshes the size of the entire . + + + + + Lists the available page view modes. + + + + + The document is re-sized to fit the page width into the Print Preview’s dimensions. + + + + + The document is re-sized to fit the specified number of page rows and columns. + + + + + The document zooming is adjusted so as to fit the whole page width. + + + + + The document is re-sized to fit the entire page within the Print Preview’s dimensions. + + + + + A visual brick containing other bricks. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified brick style. + + A object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets a collection of bricks which are contained in this . + + A object which contains bricks belonging to this panel brick. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Panel”. + + + + Center-aligns child bricks contained within the current panel brick. + + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Disposes of the object. + + + + + Gets or sets a value indicating whether child bricks that are contained within the current panel brick should be merged into a single object. + + true if child bricks should be merged; otherwise, false. + + + + Overrides the VisualBrick.Text property to hide it. + + A value. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + Lists the values specifying the PDF/A compatibility mode of a document. + + + + + The document is not PDF/A-compatible and supports the ISO 32000-1:2005 specification. + + + + + The document supports the PDF/A-1a (Accessible) specification and contains tags that assistive technologies can use. + + + + + The document supports the PDF/A-1b (ISO 19005-1) specification. + + + + + The document supports the PDF/A-2a (Accessible) specification and contains tags that assistive technologies can use. + + + + + The document supports the PDF/A-2b (ISO 19005-2:2011) specification. + + + + + The document supports the PDF/A-3a (Accessible) specification and contains tags that assistive technologies can use. + + + + + The document supports the PDF/A-3b (ISO 19005-3:2012) specification. + + + + + Represents a file attached to a PDF document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the date of the attachment file creation. + + A Nullable<> value, that specifies the date of the attachment file creation. + + + + Specifies the document’s attachment file as a byte array. + + A array that contains the document’s attachment file. + + + + Specifies the attachment file’s description. + + A value. + + + + Specifies the name of the attachment file. + + A value that specifies the name of the attachment file. + + + + Specifies the path to the file to be attached to the document. + + A value, specifying the path to the file to be attached to the document. + + + + Specifies the date of the attachment file’s last modification. + + A Nullable<> value that specifies the date of the attachment file’s last modification. + + + + Specifies the relation between the document and the attachment file. + + A value, specifying the relation between the document and the attachment file.The default is .Alternative. + + + + Specifies the data type of the attachment file. + + A value, specifying the data type of the attachment file. + + + + Lists the values used to specify the type of relationship between the document and the attachment file. + + + + + The attachment file data is an alternative representation of the PDF content. + + + + + The attachment file contains data which is used for the visual representation in the PDF part. + + + + + The attachment file contains the source data for the visual representation derived from the PDF part. + + + + + The attachment file contains additional information. + + + + + The relationship is unknown or does not match any relationship above. + + + + + Contains options which specify the Document Properties of the created PDF file. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the string to be added as an Application property of the resulting PDF file. + + A which stores an Application name. + + + + Copies all the settings from the object passed as a parameter. + + A object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the string to be added as an Author property of the resulting PDF file. + + A which stores an Author name. + + + + Creates a copy of the current object. + + A object which is a copy of the current object. + + + + Specifies the default value of the PdfDocument.Producer property for all generated PDF files. + + A which stores the Producer name. + + + + Gets or sets the string to be added as a Keywords property of the resulting PDF file. + + A which stores keywords. + + + + Gets or sets the string to be added as a Producer property of the resulting PDF file. + + A which stores a Producer name. + + + + Gets or sets the string to be added as a Subject property of the resulting PDF file. + + A which stores a Subject. + + + + Gets or sets the string to be added as a Title property of the resulting PDF file. + + A which stores a Title. + + + + Lists the algorithms that can be used to encrypt PDF data. + + + + + Specifies the 128-bit AES (Advanced Encryption Standard) encryption algorithm. + + + + + Specifies the 256-bit AES (Advanced Encryption Standard) encryption algorithm. + + + + + Specifies the 128-bit ARC4 (Alleged Rivest Cipher 4) encryption algorithm. + + + + + Contains options that define how a document is exported to PDF format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the additional metadata that is added to the PDF document’s metadata. + + A value. + + + + Copies all the settings from the object passed as a parameter. + + A object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Provides access to the attachment files list of the document. + + A ICollection<> collection of files to be attached to the document. + + + + Specifies whether to convert the images contained in the document to JPEG format during the export to PDF. + + true, to convert images to JPEG; otherwise, false. + + + + Gets the options to be embedded as Document Properties of the created PDF file. + + A object which contains Document Properties options. + + + + Specifies whether to convert editable fields to AcroForms fields on PDF export. + + true, to export editable fields to PDF AcroForms fields; otherwise, false. + + + + Gets or sets the quality of images in the resulting PDF file. + + A enumeration value which specifies the quality of images in the resulting PDF file. + + + + Gets or sets a semicolon-delimited string of values with the font names which should not be embedded in the resulting PDF file. + + A which contains the font names delimited by a semicolon. + + + + Provides access to the PDF security options of the document, which require specifying a password. + + A object, representing the security options. + + + + Specifies document compatibility with the PDF/A specification. + + A enumeration value. + + + + Obsolete. Use the PdfExportOptions.PdfACompatibility property instead. + + true if the document supports PDF/A; otherwise false. + + + + Specifies document compatibility with the PDF/UA specification. + + A enumeration value. + + + + Gets or sets whether to display the Print dialog when a PDF file is opened. + + true, to show the Print dialog on open; otherwise, false. + + + + Provides access to digital signature options of . + + A object. + + + + Checks the validity of PDF export options and returns a list of any detected inconsistencies. + + A collection of values, specifying inconsistencies detected in the PDF export options. + + + + This field is obsolete (do not use this value due to security reasons). + + + + + Specifies how images are exported to PDF format. + + + + + The resulting Jpeg image quality is high (the resulting PDF file size is big). + + + + + The resulting Jpeg image quality is the highest (the resulting PDF file size is the biggest). + + + + + The resulting Jpeg image quality is low (the resulting PDF file size is small). + + + + + The resulting Jpeg image quality is the lowest (the resulting PDF file size is the smallest). + + + + + The resulting Jpeg image quality is medium (the resulting PDF file size is also medium). + + + + + Defines the security access options for the exported PDF document. + + + + + Initializes a new instance of the class. + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Specifies the algorithm used to encrypt PDF content. + + A enumeration value. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the password for opening the exported PDF document. + + A value, representing the password. + + + + Provides access to the PDF permission options of the document. + + A object, representing the security permission options for the exported PDF document. + + + + Specifies the PDF permissions password for the document. + + A value, representing the permissions password. + + + + Defines the security permission options for the exported PDF document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Specifies the permissions for changing the exported PDF document. + + A object, that contains the changing permissions. + + + + Creates a copy of the current instance. + + A object which represents an exact copy of the current object. + + + + Specifies the permissions for copying the exported PDF document. + + true to enable document copying; otherwise, false. + + + + Specifies the permissions for copying the content of the exported PDF document. + + true to enable copying of the document content; otherwise, false. + + + + Specifies the permissions for screen readers access to the exported PDF document. + + true to enable screen readers access; otherwise, false. + + + + Determines whether or not the specified object is equal to the current instance. + + The object to compare with the current object. + true if the specified object is equal to the current instance; otherwise false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Specifies the permissions for printing the exported PDF document. + + A object, containing the printing permissions. + + + + Contains options that specify how to print PDF content. + + + + + Initializes a new instance of the class. + + + + + Specifies the engine that renders PDF content. + + The engine that renders PDF content. + + + + Contains the settings to apply an X.509 certificate to the resulting PDF file to digitally sign the document. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as the parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Specifies an X.509 certificate of . + + A object. + + + + Creates a copy of the current object. + + An object which is a copy of the current object. + + + + Specifies the contact information of the person in charge of the certificate. + + A value. + + + + Specifies the default hash algorithm to be used in PDF documents generated within the application. + + The default hash algorithm to be used in PDF documents generated within the application. + + + + Determines whether or not the specified object is equal to the current instance. + + A instance against which to compare with the current instance. + true if a specific instance equals the current instance; otherwise, false. + + + + Serves as the default hash function. + + An integer value, specifying the hash code for the current object. + + + + Specifies the hash algorithm to be used in a PDF document. + + The hash algorithm to be used in a PDF document. + + + + Specifies the certificate’s location. + + A value. + + + + Specifies the reason for encrypting the file. + + A value. + + + + Lists values that specify whether a document conforms to the PDF/UA specification. + + + + + The document is not PDF/UA-compatible. + + + + + The document conforms to the PDF/UA specification. + + + + + Provides data for the PrintingSystemBase.StartPrint event. + + + + + Gets the object that sends the document’s output to a printer. + + A object representing the printing settings of the document. + + + + Provides access to the corresponding printer settings. + + A printer settings. + + + + Represents the method that will handle the PrintingSystemBase.StartPrint event. + + An object of any type that triggers the PrintingSystemBase.StartPrint event. + A object that provides data for the PrintingSystemBase.StartPrint event. + + + + Represents options that specify which of the default printer’s settings should be used when printing a document. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified values for its properties. + + A object specifying the initial values for the class properties. + + + + Initializes a new instance of the class with the specified paper kind and orientation settings of the system’s default printer. + + true to use the paper kind of the default printer’s settings; otherwise, false. This value is assigned to the PrinterSettingsUsing.UsePaperKind property. + true to use the landscape values of the default printer’s settings; otherwise, false. This value is assigned to the PrinterSettingsUsing.UseLandscape property. + + + + Gets a value indicating whether or not all of the default printer settings are used for printing a report. + + true, if all of the default printer settings are used for printing a report; otherwise, false. + + + + Gets a value indicating whether or not any of the default printer settings are used for printing a report. + + true, if at least one of the default printer settings is used for printing a report; otherwise, false. + + + + Specifies whether or not the Landscape setting of the system’s default printer is used when printing a document. + + true, to use the page orientation of the default printer’s settings; otherwise, false. + + + + Specifies whether or not the Paper Kind setting of the system’s default printer is used when printing a document. + + true, to use the paper kind of the default printer’s settings; otherwise, false. + + + + A static class that contains a set of options that specify how to print visual elements. + + + + + Exposes options that specify how to print PDF content. + + Options that specify how to print PDF content. + + + + Specifies the document printing permissions. + + + + + Permits the PDF document’s printing in high resolution only, unless the PdfPasswordSecurityOptions.PermissionsOptions are accessed and modified. + + + + + Permits the PDF document’s printing in low resolution only (150 dpi), unless the PdfPasswordSecurityOptions.PermissionsOptions are accessed and modified. + + + + + Forbids printing of the PDF document, unless the PdfPasswordSecurityOptions.PermissionsOptions are accessed and modified. + + + + + Lists the available activity modes that relate to a link’s LinkBase.Activity property. + + + + + The document is being exported. + + + + + The document creation process is idle. + + + + + The document creation process is being prepared. + + + + + The document is being printed. + + + + + The base for classes that provide the basic printing functionality in different environments. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new class instance and adds it to the form’s container. + + An IContainer that contains an XtraPrintingSystemBase component, if any. + + + + Adds the specified command handler to the command handlers list for one or several of the printing system commands (listed in the enumeration). + + An object implementing the interface. + + + + Adds the specified service to the service container. + + The type of service to add. + A callback object that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested. + true if this service should be added to any parent service containers; otherwise, false. + + + + Adds the specified service to the service container. + + The type of service to add. + A callback object that can create the service. This allows a service to be declared as available, but delays creation of the object until the service is requested. + + + + Adds the specified service to the service container. + + The type of service to add. + An instance of the service type to add. This object must implement or inherit from the type indicated by the serviceType parameter. + true if this service should be added to any parent service containers; otherwise, false. + + + + Adds the specified service to the service container. + + The type of service to add. + An instance of the service to add. This object must implement or inherit from the type indicated by the _serviceType_parameter. + + + + Occurs after a band has been printed on a page. + + + + + For internal use. Occurs after all document pages have been created. + + + + + Occurs on raising any PrintingSystem event that does not have the “Before” prefix in its name. + + + + + Obsolete; the event is not raised. + + + + + Occurs after a specific page has been painted in a Print Preview. + + + + + For internal use. Occurs after every time any page of the printing system’s is printed. + + + + + For internal use. Occurs before document pages are created. + + + + + Occurs on raising any PrintingSystem event that has the “Before” prefix in its name. + + + + + Occurs when page margins are about to change. + + + + + Occurs before a specific page has been painted in a Print Preview. + + + + + Indicates that report generation has started. + + + + + Must be called before subreport creation. + + The distance between the current subreport and the previously created item. + + + + For internal use. + + + + + For internal use. + + A Boolean value. + + + + Clears the current document. + + + + + Gets or sets a value indicating whether pages should be renumbered following reordering in the PrintingSystemBase.Pages collection. + + true to renumber pages; otherwise, false. + + + + Creates a specific brick type. + + The type of created brick. + The created brick. + + + + Occurs when an exception is raised during document creation. + + + + + Creates a new empty page using the current printing system’s page settings. + + A object which represents a new empty page. + + + + Specifies the culture used for date and time values in the control. + + A object. + + + + Gets the current document. + + A object. + + + + Occurs each time a value of an edit field changes. + + + + + Provides access to the collection of fields whose content can be edited in Print Preview. + + The collection of fields whose content can be edited in Print Preview. + + + + Finishes a report’s generation. + + + + + Finishes a report’s generation. + + true to enable accessing document pages progressively as they are created; otherwise false. + + + + Occurs after the document is ready to print. Does not indicate that the actual printing process completed successfully. + + + + + Signals that subreport creation is completed. + + + + + Executes the specified printing system command and passes the specified parameters. + + A enumeration value representing the command to be executed. + A collection of objects, representing the parameters to be passed to the executing command. + + + + Executes the specified printing system command. + + A enumeration value representing the command to be executed. + + + + Gets the settings used to specify export parameters when exporting a printing system’s document. + + An object which contains the export settings for a printing system’s document. + + + + Exports a document to the specified stream in CSV format using the defined CSV-specific options. + + A object to which the created CSV file should be sent. + A object which specifies the CSV export options to be applied when a document is exported. + + + + Exports a document to the specified stream in CSV format. + + A object to which the created CSV file should be sent. + + + + Exports a document to the specified file path in CSV format using the defined CSV-specific options. + + A which specifies the file name (including the full path) for the created CSV file. + A object which specifies the CSV export options to be applied when a document is exported. + + + + Exports a document to the specified file path in CSV format. + + A which specifies the file name (including the full path) for the created CSV file. + + + + Exports a document to the specified stream in DOCX format using the specified DOCX-specific options. + + A object to which the created DOCX file should be sent. + A object that specifies the DOCX export options to be applied when a document is exported. + + + + Exports a document to the specified stream in DOCX format. + + A object to which the created DOCX file should be sent. + + + + Exports a document to the specified file path in DOCX format using the specified DOCX-specific options. + + A value that specifies the file name (including the full path) for the created DOCX file. + A object that specifies the DOCX export options to be applied when a document is exported. + + + + Exports a document to the specified file path in DOCX format. + + A value that specifies the file name (including the full path) for the created DOCX file. + + + + Exports a document to the specified stream in HTML format with the specified options. + + A object for the created HTML file. + An object that specifies the HTML export options. + + + + Exports a document to the specified stream in HTML format. + + A object to which the created HTML file should be sent. + + + + Exports a document to the specified file path in HTML format using the defined HTML-specific options. + + A which specifies the file name (including the full path) for the created HTML file. + An object which specifies the HTML export options to be applied when a document is exported. + + + + Exports a document to the specified file path in HTML format. + + A which specifies the file name (including the full path) for the created HTML file. + + + + Exports a document to an image with the specified format and sends it to a stream. + + The output stream. + An object that specifies the image format. + + + + Exports a document to the specified stream in Image format using the defined Image-specific options. + + A object for the exported image. + An object that specifies the export options. + + + + Exports a document to the specified stream as an image. Use options to specify an image format. + + A object for the exported image. + + + + Exports a document to an image with the specified format and saves it to a file. + + The file name (including the full path) for the created image file. + An object that specifies the image format. + + + + Exports a document to the specified file path in Image format with the specified options. + + A that specifies the file name (including the full path) for the created image file. + An object that specifies the export options. + + + + Exports a document to the specified file path in Image format. + + A that specifies the file name (including the full path) for the created image file. + + + + Exports a document to HTML and then inserts it into a specified e-mail. + + A object. + + + + Exports a document to HTML and then inserts it into a specified e-mail. + + A object. + A value, specifying the sender. + A value, specifying a comma-separated list of recipients. + A value, specifying the e-mail subject. + A object. + + + + Exports a document to HTML and then inserts it into a specified e-mail. + + A object. + A object. + + + + Exports a document to HTML and then inserts it into a specified e-mail. + + A value, specifying the sender. + A value, specifying a comma-separated list of recipients. + A value, specifying the e-mail subject. + A object. + + + + Exports a document to the specified stream in MHT format using the defined MHT-specific options. + + A object to which the created MHT file should be sent. + An object that specifies the MHT export options to be applied when a document is exported. + + + + Exports a document to the specified stream in MHT format. + + A object to which the created MHT file should be sent. + + + + Exports a document to the specified file path in MHT format using the defined MHT-specific options. + + A which specifies the file name (including the full path) for the created MHT file. + An object which specifies the MHT export options to be applied when a document is exported. + + + + Exports a document to the specified file path in MHT format. + + A which specifies the file name (including the full path) for the created MHT file. + + + + Exports a document to the specified stream in PDF format using the defined PDF-specific options. + + A object to which the created PDF file should be sent. + A object which specifies the PDF export options to be applied when a document is exported. + + + + Exports a document to the specified stream in PDF format. + + A object to which the created PDF file should be sent. + + + + Exports a document to the specified file path in PDF format using the defined PDF-specific options. + + A which specifies the file name (including the full path) for the created PDF file. + A object which specifies the PDF export options to be applied when a document is exported. + + + + Exports a document to the specified file path in PDF format. + + A which specifies the file name (including the full path) for the created PDF file. + + + + Exports a document to the specified stream in RTF format using the defined RTF-specific options. + + A to which the created RTF file should be sent. + An object, representing options, which define how a document is exported to RTF format. + + + + Exports a document to the specified stream in RTF format. + + A object to which the created RTF file should be sent. + + + + Exports a document to the specified file path in RTF format using the defined RTF-specific options. + + A , which specifies the file name (including the full path) for the created RTF file. + An object, representing options, which define how a document is exported to RTF format. + + + + Exports a document to the specified file path in RTF format. + + A which specifies the file name (including the full path) for the created RTF file. + + + + Exports a document to the specified stream in Text format using the defined Text-specific options. + + A object to which the created Text file should be sent. + A object which specifies the Text export options to be applied when a document is exported. + + + + Exports a document to the specified stream in Text format. + + A object to which the created Text file should be sent. + + + + Exports a document to the specified file path in Text format using the defined Text-specific options. + + A which specifies the file name (including the full path) for the created Text file. + A object which specifies the Text export options to be applied when a document is exported. + + + + Exports a document to the specified file path in Text format. + + A which specifies the file name (including the full path) for the created Text file. + + + + Exports a report to the specified stream in XLS format using the defined XLS-specific options. + + A object to which the created XLS file should be sent. + An object which specifies the XLS export options to be applied when a report is exported. + + + + Exports a report to the specified stream in XLS format. + + A object to which the created XLS file should be sent. + + + + Exports a report to the specified file path in XLS format using the defined XLS-specific options. + + A which specifies the file name (including the full path) for the created XLS file. + An object which specifies the XLS export options to be applied when a report is exported. + + + + Exports a report to the specified file path in XLS format. + + A which specifies the file name (including the full path) for the created XLS file. + + + + Exports a report to the specified stream in XLSX format using the defined XLSX-specific options. + + A object to which the created XLSX file should be sent. + An object which specifies the XLSX export options to be applied when a report is exported. + + + + Exports a report to the specified stream in XLSX format. + + A object to which the created XLSX file should be sent. + + + + Exports a report to the specified file path in XLSX format using the defined XLSX-specific options. + + A which specifies the file name (including the full path) for the created XLSX file. + An object which specifies the XLSX export options to be applied when a report is exported. + + + + Exports a report to the specified file path in XLSX format. + + A which specifies the file name (including the full path) for the created XLSX file. + + + + Exports a document to the specified stream in XPS format using the specified XPS-specific options. + + A object to which the created XPS file should be sent. + An object which specifies the XPS export options to be applied when a document is exported. + + + + Exports a report to the specified file path in XPS format using the specified XPS-specific options. + + A which specifies the file name (including the full path) for the created XPS file. + An object which specifies the XPS export options to be applied when a report is exported. + + + + Fires after page rendering if a gap remains between the rendered areas. + + + + + For internal use. + + + + + Gets the current visibility of the specified printing system command. + + A enumeration value which represents the visibility of the specified command. + A enumeration value which specifies the command whose visibility is to be determined. + + + + Gets the intersecting bricks within the document. + + A collection of intersecting objects. + + + + Gets a object used for drawing in the current report. + + A object. + + + + Highlights the intersecting bricks within the document. + + A to paint the intersecting bricks. + + + + Inserts a page break at a specified position. + + A value which specified the position to insert a page break. + + + + Gets the orientation of a report page. + + true, if the landscape page orientation is used; otherwise, false. + + + + Loads a document from a object, containing data in a native XML format (PRNX). + + A object containing PRNX data. + + + + Loads a document from a file in a native XML format (PRNX). + + A , which specifies the file name (including the full path) of the PRNX file to be loaded. + + + + Prevents the document from being modified. + + + + + Draws a selection rectangle around the specified brick located on the specified page. + + A object representing the brick around which a selection rectangle will be drawn. + A object representing the page on which the brick is located. Note that if a brick is split across two or more pages, then only the part of the brick which is located on the specified page will be selected. + + + + Gets the bounds of a report page. + + A that represents page length and width (in hundredths of an inch). + + + + Gets the number of document pages. + + An integer value. + + + + For internal use. + + + + + Gets the current page margin settings. + + + + + Provides access to a collection of pages generated for this printing system. + + A object which represents a collection of pages. + + + + Gets the current page settings. + + An object containing the current page settings. + + + + Obsolete; the event is not raised. + + + + + For internal use. + + + + + The event is raised before a document page is sent to a printer. The event is not raised in non-Windows environments. + + + + + Provides access to the object that reflects the current state of a document’s generating or exporting. + + A object which is intended to track the process of a document’s creation. + + + + Removes the existing command handler for one or several of the printing system commands (listed in the enumeration). + + An object implementing the interface. + + + + Removes the specified service type from the service container. + + The type of service to remove. + true if this service should be removed from any parent service containers; otherwise, false. + + + + Removes the specified service type from the service container. + + The type of service to remove. + + + + Resets all settings of the printing system’s PrintingSystemBase.ProgressReflector. + + + + + Saves a document to a object in a native XML format (PRNX) using the specified PRNX-specific options. + + A object to which the created PRNX file should be sent. + A object which specifies the PRNX-specific options to be applied when a document is saved. + + + + Saves a document to a object in a native XML format (PRNX). + + A object to which the created PRNX file should be sent. + + + + Saves a document to the specified file path in a native XML format (PRNX) using the specified PRNX-specific options. + + A which specifies the file name (including the full path) for the created PRNX file. + A object which specifies the PRNX-specific options to be applied when a document is saved. + + + + Saves a document to the specified file path in a native XML format (PRNX). + + A which specifies the file name (including the full path) for the created PRNX file. + + + + Occurs when a scale factor of the current document has been changed. + + + + + For internal use. + + + + + Changes the visibility of the specified printing system command. + + A enumeration value which specifies the command whose visibility needs to be changed. + A enumeration value which specifies the new visibility state for the commands. + + + + Changes the visibility of the specified printing system command. + + An array of enumeration values which specify the commands whose visibility needs to be changed. + A enumeration value which specifies the new visibility state for the commands. + + + + Gets or sets a value which specifies whether an error message is shown when the page margins are set outside the printable area. + + true to show the margins warning dialog; otherwise false. + + + + Specifies whether or not to show a print status dialog when printing a document. + + true to show the print status dialog; otherwise false. + + + + Occurs before the printing system’s document is printed. + + + + + Unlocks a previously locked document. + + + + + Removes a selection rectangle which was previously drawn around the specified brick using the PrintingSystemBase.MarkBrick method. + + A object representing the brick which should be deselected. + A object representing the page on which the brick is located. Note that if a brick is split across two or more pages, then only the part of the brick which is located on the specified page will be deselected. + + + + Specifies the name of the user that created the document. + + A value. + + + + Gets the collection of watermarks. + + A collection of watermarks. + + + + Occurs after creation of an XLS or XLSX document worksheet has finished. + + + + + Represents different settings used to specify how a document is exported from the Print Preview. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value which indicates whether the resulting file should be automatically opened after exporting a document from the Print Preview. + + An enumeration value which specifies the action performed after export is finished. + + + + Gets or sets the file path to which, by default, a document is exported from the Print Preview. + + A which represents the default file path. + + + + Specifies the default format to which a document is exported from the Print Preview form. + + A enumeration value, corresponding to the required export format. + + + + Gets or sets the file name to which, by default, a document is exported from the Print Preview. + + A which represents the default file name. + + + + Identifies the default file name for a document being exported from the Print Preview. + + + + + Specifies the default format to which a document is converted, when the PrintingSystemCommand.SendFile command is executed. + + A enumeration value, corresponding to the required format. + + + + Gets or sets a value which specifies how the file path to export a document is obtained when exporting a document from the Print Preview. + + A enumeration value which specifies how the file path is obtained. + + + + Gets or sets a value which indicates whether an Export Options window should be shown when an end-user exports a document from the Print Preview. + + true to show the Export Options window; otherwise, false. + + + + Provides data for the PrintingSystemBase.PrintProgress and XtraReport.PrintProgress events. + + + + + Gets the index of the current page that should be sent to a printer, next. + + An integer value representing the zero-based page index. + + + + Gets or sets the page settings of the current page that should be sent to a printer, next. + + A object, containing page settings of the current page. + + + + Gets a value indicating what type of print operation is occurring. + + One of the enumeration vlaues. + + + + Represents the method that will handle the PrintingSystemBase.PrintProgress event. + + An object of any type that triggers the PrintingSystemBase.PrintProgress event. + A object that provides data for the PrintingSystemBase.PrintProgress event. + + + + The base class for the class. + + + + + Initializes a new instance of the class with the specified Printing System. + + A object that represents the Print Tool’s Printing System. This value is assigned to the PrintToolBase.PrintingSystem property. + + + + Prints the current document on the default printer. + + + + + Prints the current document on the specified printer. + + A representing the name of the printer on which the current document should be printed. + + + + Prints the current document on the specified printer asynchronously. + + A that is the name of the printer where the current document is sent. + An asynchronous operation result. + + + + Provides access to the corresponding printer settings. + + A object. + + + + Provides access to the Printing System of the . + + A class descendant. + + + + A visual brick containing a progress bar. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Initializes a new instance of the class with the specified position. + + An integer value specifying the progress bar position. This value is assigned to the ProgressBarBrick.Position property. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “ProgressBar”. + + + + Gets or sets the color to fill a progress bar brick’s content. + + A object which specifies the fill color of a progress bar. + + + + Gets or sets the color of progress bars displayed in the current brick. + + A which represents the progress bars color. + + + + Gets or sets the current position of the progress bar brick. + + An integer value which represents the current position (0-100). + + + + Overrides the VisualBrick.Text property to hide it. + + A value. + + + + Overrides the VisualBrick.TextValue property. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A which represents the text value that will be shown as the brick’s text. + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + Reflects the current state of document printing or exporting. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value indicating whether the ‘s range can be auto-created. + + true if a range can be auto-created; otherwise, false. + + + + Disables the progress reflector. + + + + + Enables the progress reflector. + + + + + For internal use. + + + + + Initializes the and sets its maximum value to the specified value. + + An integer value to be set to the maximum value of the . + + + + Initializes the ‘s range using the specified maximum value. + + An integer value to be set to the maximum value of the . + + + + Specifies the logic for the class. For internal use only. + + + + + Sets the maximum value that is possible for the current range, indicating that the process has been finished. + + + + + Sets the maximum possible value to the ProgressReflector.Value property, indicating that the process has been finished. + + + + + Gets the maximum value of the current . + + An integer value. + + + + Gets the value indicating the current position of the . + + An integer value. + + + + Occurs after the position of the current range has been changed. + + + + + Returns the number of sub-ranges for the . + + An integer value, specifying the number of ranges. + + + + Gets or sets a value which reflects the state of a process within the current range. + + A value which represents the state of a process. + + + + Registers the specified progress reflector as an active reflector to show current progress. + + A object to register as the active reflector. + + + + For internal use. Sets the ranges which will be used by the to reflect progress states. + + An array of values which represent the ranges reflecting progress states. + A ProgressReflectorLogic object. + + + + Sets the ranges which will be used by the to reflect progress states. + + An array of values which represent the ranges reflecting progress states. + + + + Sets the ranges which will be used by the to reflect progress states. + + An array of float values which represent the ranges reflecting progress states. + + + + Unregisters the specified progress reflector, so it will no longer show the current progress. + + A object to unregister. + + + + Gets or sets a value which reflects the state of a process being tracked by this . + + A float value which represents the state of a process. + + + + Defines the recipient settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified address and field type. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + A value that specifies the recipient field type. This value is assigned to the Recipient.FieldType property. + + + + Initializes a new instance of the class with the specified address, contact name, and field type. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + A value that specifies the recipient contact name. This value is assigned to the Recipient.ContactName property. + A value that specifies the recipient field type. This value is assigned to the Recipient.FieldType property. + + + + Initializes a new instance of the class with the specified address, contact name and the message prefix. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + A value that specifies the recipient contact name. This value is assigned to the Recipient.ContactName property. + A value that specifies the prefix defining a way to send messages. This value is assigned to the Recipient.Prefix property. + A value that specifies the recipient field type. This value is assigned to the Recipient.FieldType property. + + + + Initializes a new instance of the class with the specified address, contact name, field type and the message prefix. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + A value that specifies the recipient contact name. This value is assigned to the Recipient.ContactName property. + A value that specifies the prefix defining a way to send messages. This value is assigned to the Recipient.Prefix property. + + + + Initializes a new instance of the class with the specified address and contact name. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + A value that specifies the recipient contact name. This value is assigned to the Recipient.ContactName property. + + + + Initializes a new instance of the class with the specified recipient address. + + A value that specifies the recipient e-mail address. This value is assigned to the Recipient.Address property. + + + + Specifies the recipient’s email address. + + A value. + + + + Specifies the email recipient name. + + A value. + + + + Specifies the email recipient type. + + A value. + + + + Specifies the email message prefix (e.g., “SMTP:“ or “Fax:“). + + A value. + + + + Returns the textual representation of the class. + + A value. + + + + A collection of objects, specifying the list of recipients who are to receive an exported document via email. + + + + + Initializes a new instance of the class with the default settings. + + + + + Appends an array of recipients to the collection. + + An array of the class descendants to append to the collection. + + + + Provides access to individual items in the collection by their address. + + A value specifying the address of the recipient to get. + A which represents the recipient with the specified address. + + + + Lists the values used to specify the field type to which the current recipient belongs. + + + + + Indicates the BCC (blind carbon copy) field type. + + + + + Indicates the CC (carbon copy) field type. + + + + + Indicates the To field type (the field of primary recipients). + + + + + Lists the available RTF export modes. + + + + + A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting RTF file only once, at the beginning and at the end of the document. + + + + + A document is exported to a single file, page-by-page. + + + + + Contains options which define how a document is exported to RTF format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets a value indicating how a document is exported to RTF. + + An enumeration value which represents the RTF export mode. + + + + Specifies how the file path to export a document is obtained, when exporting a document which is currently displayed in the Print Preview. + + + + + A document is exported to the path specified by the PrintPreviewOptions.DefaultDirectory and PrintPreviewOptions.DefaultFileName properties. So, the Save File dialog isn’t shown in this case. + + + + + A document is exported using the file path and the file name specified by an end-user in the Save File dialog, which is shown prior to exporting a document. + + + + + Contains classes that implement the shape functionality in XtraPrinting. + + + + + Defines the base class for all the shape types represented by a closed figure. + + + + + Defines the base class for all the shape types whose corners can be filleted. + + + + + Gets or sets a value specifying how shape corners are rounded (in percent). + + An integer value which shows how corners are rounded. This value should be from 0 to 100. + + + + Contains the enumeration that is used to localize the names of various supported shapes. + + + + + Lists the values that are used to localize the names of supported kinds. + + + + + “Arrow“ + + + + + “Backslant Line“ + + + + + “Bottom Arrow“ + + + + + “Brace“ + + + + + “Bracket“ + + + + + “Cross“ + + + + + “8-Point Star“ + + + + + “Ellipse“ + + + + + “5-Point Star“ + + + + + “4-Point Star“ + + + + + “Hexagon“ + + + + + “Horizontal Line“ + + + + + “Left Arrow“ + + + + + “Line“ + + + + + “Octagon“ + + + + + “Pentagon“ + + + + + “Polygon“ + + + + + “Rectangle“ + + + + + “Right Arrow“ + + + + + “6-Point Star“ + + + + + “Slant Line“ + + + + + “Square“ + + + + + “Star“ + + + + + “3-Point Star“ + + + + + “Top Arrow“ + + + + + “Triangle“ + + + + + “Vertical Line“ + + + + + Represents the arrow shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the height of an arrow (in percent). + + An integer value which represents the height of an arrow. This value should be from 0 to 100. + + + + Gets or sets the width of an arrow (in percent). + + An integer value which represents the width of an arrow. This value should be from 0 to 100. + + + + Defines the base class for all the shape types. + + + + + Override this method to get the name of the shape. + + A string, representing the shape’s name. + + + + Represents the brace shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a value which specifies how brace corners are rounded. + + An integer value which represents how brace corners are rounded. + + + + Gets or sets the length of a brace’s tail. + + An integer value which represents a tail’s length. + + + + Represents the bracket shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the length of a brace’s tip. + + An integer value which represents a tip’s length. + + + + Represents the cross shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the horizontal line width of a cross (in percents). + + An integer value which represents the width of a horizontal line. + + + + Gets or sets the vertical line width of a cross (in percents). + + An integer value which represents the width of a vertical line. + + + + Represents the ellipse shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents the line shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents the regular polygon shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the number of polygon sides. + + An integer value which represents the number of sides in a polygon. + + + + Defines the base class for all the shape types based on a regular polygon. + + + + + Represents the rectangle shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents the regular star shape type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the star‘s concavity value. + + A value. + + + + Gets or sets the number of points for the star shape. + + An integer value that specifies the number of points for the star shape. + + + + A visual brick containing a shape. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets or sets the angle (in degrees) by which the shape’s image is rotated. + + An integer value specifying the angle by which the shape’s image is rotated. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Shape”. + + + + Gets or sets the color to fill the shape’s contents. + + A object which represents the fill color of a shape. + + + + Gets or sets the color of the shape displayed in the current brick. + + A which represents the shape color in the current brick. + + + + Specifies the ‘s line style. + + + + + Gets or sets the width of the line which is used to draw the shape image. + + An integer value representing the width of the line. + + + + Gets or sets an object which determines a particular shape type along with its settings. + + A class descendant which contains settings for a particular shape type. + + + + Gets or sets a value indicating whether or not to stretch a shape when it’s rotated. + + true to stretch the shape; otherwise, false. + + + + Overrides the VisualBrick.Text property to hide it. + + A value. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + Contains settings that specify whether an control should show the signature image. + + + + + Hide the signature image. + + + + + Show the signature image. + + + + + Show the certificate name in place of the signature image. + + + + + Lists the cell size modes supported by the control. + + + + + Only the cell height depends on the current font size of a control (the XRCharacterComb.CellHeight property is ignored), and the XRCharacterComb.CellWidth value is specified manually. + With this setting, the actual cell height does not depend on the specified border width of a control, while the effective cell width is the difference between the specified XRCharacterComb.CellWidth and XRControl.BorderWidth values. + + + + + The cell size depends on the current font size of a control (the XRCharacterComb.CellHeight and XRCharacterComb.CellWidth properties are ignored). + With this setting, the actual cell size does not depend on the specified border width of a control. + + + + + Only the cell width depends on the current font size of a control (the XRCharacterComb.CellWidth property is ignored), and the XRCharacterComb.CellHeight value is specified manually. + With this setting, the actual cell width does not depend on the specified border width of a control, while the effective cell height is the difference between the specified XRCharacterComb.CellHeight and XRControl.BorderWidth values. + + + + + The cell size is determined by the XRCharacterComb.CellHeight and XRCharacterComb.CellWidth property values and does not depend on the assigned font size. + With this setting, the actual cell size is less than the specified CellHeight and CellWidth by the XRControl.BorderWidth value. + + + + + Represents a row in the . + + + + + Initializes an instance of the class. + + + + + Gets the array of bricks held by the . + + A BrickList object which represents the array of bricks held by the . + + + + Represents a collection of rows owned by the . + + + + + Initializes a new instance of the class that is empty and has the default initial capacity. + + + + + Adds the specified object to the collection. + + A object to add to the collection. + An integer value indicating the position into which the new element was inserted. + + + + Initializes a new instance of the class and adds it to the collection. + + The object added to the collection of rows. + + + + Provides indexed access to individual items in the collection. + + A zero-based integer specifying the desired item’s position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + A object which represents the table row at the specified position. + + + + A visual brick that contains text. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value, specifying the visibility of the brick’s borders. + A value, specifying the brick’s border width. + A structure, specifying the color of the brick’s borders. + A structure, specifying the brick’s background color. + A structure, specifying the brick’s foreground color. + + + + Initializes a new instance of the class with the specified brick style. + + A object. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Text”. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Defines the font used to draw text within the current brick. + + The used font. + + + + Gets or sets the horizontal alignment of the text. + + A value that specifies the horizontal alignment of the text. + + + + Gets or sets the formatting string applied to the brick’s text. + + A object which represents the formatting string for the brick’s text. + + + + Gets an object which represents the value that will be shown as the brick’s text. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A which represents the text value that will be shown as the brick’s text. + + + + Gets or sets the format string which is applied to the TextBrick.TextValue. + + A value. + + + + Gets or sets the vertical alignment of the text. + + A value that specifies the vertical alignment of the text. + + + + For internal use. Specifies the format settings that are applied to a document when it is exported to XLS format. + + A enumeration value. + + + + Gets or sets the format settings used when a document is exported to an Excel file (XLS or XLSX). + + A value, representing the format string. + + + + Represents the base class for brick classes which contain text. + + + + + Gets or sets the color of the text displayed in the current brick. + + A which represents the text color in the current brick. + + + + Gets or sets the text to be displayed within the current brick. + + A representing the text to be displayed within the brick. + + + + An editing field for changing the content of text controls in Print Preview. + + + + + Creates a new instance of the class with the specified visual brick. + + A visual brick used to render an editing field in Print Preview. This value is assigned to the EditingField.Brick property. + + + + Specifies the name of an editor used to change a field value in Print Preview. + + A string that specifies the editor name. + + + + Specifies whether to use the formatting of the data fields in the bound dataset for the cells in the exported XLS (or XLSX) document. + + + + + Exports all data fields to the XLS (or XLSX) file as strings, with the corresponding non-HTML formatting embedded into those strings. HTML tags are ignored. + + + + + Exports all data fields to the XLS (or XLSX) file using the same formatting as they have in the original document. + + + + + Contains options which define how a document is exported to text. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified separator, encoding and text export mode settings. + + A containing symbols which will be used to separate the document’s text elements in the created text file. This value is assigned to the TextExportOptionsBase.Separator property. + A class descendant specifying the encoding of the created TXT document. This value is assigned to the TextExportOptionsBase.Encoding property. + A object, which specifies a format in which data values should be saved. + + + + Initializes a new instance of the class with the specified separator and encoding settings. + + A containing symbols which will be used to separate the document’s text elements in the created text file. This value is assigned to the TextExportOptionsBase.Separator property. + A class descendant specifying the encoding of the created text document. This value is assigned to the TextExportOptionsBase.Encoding property. + + + + Initializes a new instance of the class with the specified separator settings. + + A containing symbols which will be used to separate the document’s text elements in the created text file. This value is assigned to the TextExportOptionsBase.Separator property. + + + + Contains the default value for the TextExportOptionsBase.Separator property. By default, when a document is exported to a Text file, this value is equal to “\t“. + + + + + Represents the base class for objects which define export options specific for Text and CSV formats. + + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the encoding of the text-based file to which a report is exported. + + A class descendant specifying the encoding of the text-based file. + + + + Gets or sets a value used to serialize the TextExportOptionsBase.Encoding property. + + An enumeration value which represents the encoding type of the created text-based document. + + + + Returns the character(s) used as text separators for CSV export. + + A value, specifying the actual separator character(s). + + + + Gets or sets a value indicating whether a string with separators should be placed in quotation marks when a document is exported to a Text-based file. + + true to quote (place quotation marks around) text elements containing symbols which are the same as the specified separator string; otherwise, false. + + + + Gets or sets the symbol(s) to separate text elements when a document is exported to a Text-based file. + + A containing the symbol(s) which will be used to separate text elements in the created Text-based file. + + + + Gets or sets a value indicating whether to use the formatting of the data fields in the bound dataset for the cells in the exported TXT, CSV, XLS or XLSX document. + + A enumeration value. + + + + An object implementing the interface that is drawn using the IBrickGraphics.DrawBrick method. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the alignment of brick within the page layout rectangle. + + A enumeration, specifying the alignment. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “PageUser”. + + + + Gets or sets the brick alignment related to the top of the parent area. + + A enumeration member, specifying the alignment. + + + + A visual brick that is drawn on a page by an object implementing the interface. + + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Default”. + + + + Gets a user implementation of the interface drawn via the IBrickGraphics.DrawBrick method. + + User implementation of the interface. + + + + For internal use. Checks whether the specified brick fits the empty space on the bottom of the page, and if it doesn’t, moves it (or part of it) to the next page. + + A object value specifying the bottom of the current page. + true to forcibly split non-separable bricks; otherwise, false. + A object specifying the suggested new end position of the current page. + A DevExpress.XtraPrinting.IPrintingSystemContext interface, used to access page settings. + A value specifying the new location of the empty space on the bottom of the page. In an instance where the brick on the page has to be moved to the next page, the new bottom position of the current page will be returned. + + + + Checks whether the specified brick fits the empty space on the right side of the page and if it doesn’t, moves it (or part of it) to the next page. + + A value specifying the right edge of the current page. + A object specifying the suggested new right position of the current page. + A value specifying the new location of the empty space on the right side of the page. In an instance where the brick on the page has to be moved to the next page, the new right position of the current page will be returned. + + + + A visual brick that is rendered on a page as a simple rectangle and the base for all other visual bricks. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class. + + A enumeration value(s) which specifies the borders displayed around the brick. + A value which specifies the border width of the brick, measured in pixels. + A object which specifies the border color of the brick. + A object which specifies the background color of the brick. + + + + Initializes a new instance of the class with the specified brick style. + + A object specifying the brick style. This value is assigned to the VisualBrick.Style property. + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Defines the background color for the current . + + The background color for the current . + + + + Gets an object containing information about the bookmark for this . + + A object. + + + + Defines the border color for the current . + + The border color for the current . + + + + Specifies the dash style for the brick’s border. + + A enumeration value. + + + + Gets or sets the border style of a brick. + + A enumeration value that represents the border style of a brick. + + + + Specifies the border width of the current object. + + A value representing the border width, measured in units. + + + + Gets the owner of this brick. + + An object, which implements the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “Visual”. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + Returns the client rectangle of this . + + A object, representing the brick layout rectangle. + A value, specifying the printing resolution. + A object, representing the brick’s client rectangle. + + + + For internal use. + + An object implementing the interface. + A value. + + + + Defines the text displayed as the current brick hint. + + A value that represents the hint text of the brick. + + + + Gets a string value, which is intended for serialization of the brick’s bookmark. + + A value. + + + + Gets an index of a page, which contains a bookmark’s brick. + + An integer value representing a page index. + + + + Provides access to the brick-page pair, associated with the current brick. + + A object. + + + + Gets or sets the padding values of a brick. + + A object which contains the padding values of a brick (measured in pixels). + + + + Gets or sets the Printing System used to create and print this brick. + + A object which specifies the Printing System used to create and print this brick. + + + + For internal use. + + + + + Determines whether the current brick can be divided into several parts horizontally. + + true if the current brick can be split horizontally; otherwise, false. + + + + Determines whether the current brick can be divided into several parts vertically. + + true if the current brick can be split vertically; otherwise, false. + + + + Defines the border settings for the current . + + The border settings for the current . + + + + Gets or sets the instance used to render a brick in an appropriate format. + + A instance to render a brick. + + + + Gets or sets the text associated with the . + + Always returns . + + + + Specifies the original value for the . + + The original value for the . + + + + Specifies the format string applied to the visual brick’s TextValue. + + A value. + + + + Specifies whether the brick hint’s content corresponds to the brick’s text. + + true to use the brick’s text for the hint; otherwise, false. + + + + Checks whether the specified brick fits the empty space on the right side of the page and if it doesn’t, moves it (or part of it) to the next page. + + A value specifying the right edge of the current page. + A object specifying the suggested new right position of the current page. + A value specifying the new location of the empty space on the right side of the page. In an instance where the brick on the page has to be moved to the next page, the new right position of the current page will be returned. + + + + Specifies the native XLSX format string, to accompany the instance. + + A value, representing the XLSX format string. + + + + Contains classes that provide data contracts functionality to the client side of web reporting controls. + + + + + Provides information about a data source. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the data serialized to the report layout in JSON format using the XtraReport.ObjectStorage property. + + A value. + + + + Specifies the name of a data source serializer. + + A value, specifying the data source serializer name. + + + + Specifies the data source ID. + + A value, specifying the data source ID. + + + + Specifies whether or not the data source is a object. + + true if the data source is a ; otherwise false. + + + + Specifies the data source name. + + A value, specifying the data source name. + + + + Lists the available modes for color palette compatibility with different workbooks versions. + + + + + Degrade the color values to match the 56 standard colors of the default workbook palette. + + + + + Keep the original color values, but include only the first 56 colors into the palette. + + + + + Provides options that specify the Document Properties of the resulting Excel file. + + + + + Initializes a new instance of a class. + + + + + Specifies a string to be added as the Program name property of the resulting XLS file. + + A string value that specifies the document application name. + + + + Copies all settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. + + + + Specifies a string to be added as the Authors property of the resulting XLS file. + + A string value that specifies the document author. + + + + Specifies a string to be added as the Categories property of the resulting XLS file. + + A string value that specifies the document categories. + + + + Creates a copy of the current object. + + An object that is a copy of the current object. + + + + Specifies a string to be added as the Comments property of the resulting XLS file. + + A string value that specifies comments about the document. + + + + Specifies a string to be added as the Company property of the resulting XLS file. + + A string value that specifies the document company. + + + + Specifies a string to be added as the Subject property of the resulting XLS file. + + A string value that specifies the document primary subject. + + + + Specifies a string to be added as the Tags property of the resulting XLS file. + + A string value that specifies document tags. + + + + Specifies a string to be added as the Title property of the resulting XLS file. + + A string value that specifies the document title. + + + + Provides the options to encrypt XLS and XLSX files. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the password to open the file. + + A vaue, specifying the password to open the file. The default is string.Empty. + + + + Specifies the applied encryption mechanism. + + An enumeration value, specifying the encryption mechanism. + + + + Lists the supported encryption types. + + + + + Applies the Standard Encryption mechanism that is compatible with Excel 2007. + + + + + Applies the Agile Encryption mechanism. + + + + + Represents the base class for objects which define export options specific to XLS and XLSX formats. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A object, which specifies a format in which data values should be saved. This value is assigned to the XlExportOptionsBase.TextExportMode property. + true, to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true, to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + true to fit the output document to the page width when printing. This value is assigned to the XlExportOptionsBase.FitToPrintedPageWidth property. + A value that specifies whether to align the output document layout to support locales using right-to-left fonts. This value is assigned to the XlExportOptionsBase.RightToLeftDocument property. + + + + Initializes a new instance of the class with the specified settings. + + A object, which specifies a format in which data values should be saved. This value is assigned to the XlExportOptionsBase.TextExportMode property. + true, to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true, to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + true to fit the output document to the page width when printing. This value is assigned to the XlExportOptionsBase.FitToPrintedPageWidth property. + + + + Initializes a new instance of the class with the specified text export mode, grid lines and hyperlinks settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + + + + Initializes a new instance of the class with the specified text export mode and grid lines settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + + + + Initializes a new instance of the class with the specified text export mode. + + A object, which specifies a format in which data values should be saved. + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a System.ArgumentNullException will be thrown. + + + + Provides access to options to be embedded as the resulting XLS or XLSX file’s Document Properties. + + An object that specifies the resulting document options. + + + + Provides access to the XLS and XLSX file encryption options. + + An object. + + + + Specifies whether or not hyperlinks should be exported to Excel. + + true to export hyperlinks; otherwise false. + + + + Gets or sets whether the output document should be fit to the page height when printed. + + true, to fit the output document to the printed page height; otherwise, false. + + + + Gets or sets whether the output document should be fit to the page width when printed. + + true, if the output document should be fit to the printed page width. + + + + Specifies the document errors to be ignored in a resulting Excel file. + + An enumeration value. + + + + Enables the mode that produces simple tabular data without graphic elements, style and appearance settings. + + True, to enable the raw data export mode; otherwise false. + + + + Gets or sets whether the layout of the resulting XLS document should be aligned to support locales using right-to-left fonts. + + A value indicating whether the document layout is aligned to support locales using right-to-left fonts. + + + + Gets or sets a name of the sheet in the created XLS file to which a document is exported. + + A representing the sheet name set in the resulting XLS file. + + + + Gets or sets whether worksheet gridlines are visible in the resulting XLS file. + + true, to show worksheet gridlines in the resulting XLS file; otherwise, false. + + + + Gets or sets a value indicating whether the cells in the resulting XLS document should use the same formatting as the original document. + + A enumeration value, specifying the text export mode in the resulting XLS document. + + + + Lists the document errors that should be ignored by Excel. + + + + + No document errors are ignored in a resulting Excel file. + + + + + Values stored as text are ignored in a resulting Excel file. + + + + + Lists the available XLS export modes. + + + + + A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single XLS file. + + + + + A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting XLS file only once, at the beginning and at the end of the document. + + + + + A document is exported to a single file, page-by-page. In this mode, each page is exported to an individual sheet of the same XLS file. + + + + + Contains options which define how a document is exported to XLS format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value. This value is assigned to the XlExportOptionsBase.TextExportMode property. + true to display the grid lines; otherwise false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true to export hyperlinks; otherwise false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + true to allow more than 256 columns without warning; otherwise, false. This value is assigned to the XlsExportOptions.Suppress256ColumnsWarning property. + true to allow more than 65536 rows without warning; otherwise, false. This value is assigned to the XlsExportOptions.Suppress65536RowsWarning property. + A enumeration value. This value is assigned to the XlsExportOptions.WorkbookColorPaletteCompliance property. + + + + Initializes a new instance of the class with the specified settings. + + A object, which specifies a format in which data values should be saved. This value is assigned to the XlExportOptionsBase.TextExportMode property. + true, to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true, to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + true to fit the output document to the page width when printing. This value is assigned to the XlExportOptionsBase.FitToPrintedPageWidth property. + + + + Initializes a new instance of the class with the specified text export mode, grid lines and hyperlinks settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + + + + Initializes a new instance of the class with the specified text export mode and grid lines settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLS file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + + + + Initializes a new instance of the class with the specified text export mode. + + A object, which specifies a format in which data values should be saved. + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Specifies whether the document should be exported to a single or different XLS files, each page in a separate file. + + An enumeration value. + + + + Gets or sets the range of pages to be exported. + + A specifying the range of pages. + + + + Gets or sets a value indicating whether to suppress the exception that raises when trying to export a document to an XLS file with more than 256 columns. + + true, to suppress the exception and reduce the number of columns in the resulting XLS file; false, to cancel the export and fire the exception. + + + + Gets or sets a value indicating whether to suppress the exception that raises when trying to export a document to an XLS file with more than 65,536 rows. + + true, to suppress the exception and reduce the number of rows in the resulting XLS file; false, to cancel the export and fire the exception. + + + + Specifies the color palette compatibility mode with different workbooks versions. + + A enumeration value. + + + + Contains options that define how a document is exported to XLS format in the data-aware export mode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified text export mode. + + A enumeration value, specifying a format in which data values should be saved. This value is assigned to the TextExportOptionsBase.TextExportMode property. + + + + Fires immediately after a row is added to the output document.Only available in data-aware export mode. + + + + + Gets or sets whether cell merging is enabled for band headers in the exported document.Only available in data-aware export mode. + + A value that specifies whether cell merging is enabled for band headers in the exported document. The DefaultBoolean.Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether cell merging is enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether cell merging is enabled in the exported document. + + + + Gets or sets whether the headers of the same name are exported as merged cells. Only available in data-aware export mode. + + DefaultBoolean.True to export the headers of the same name as merged cells; DefaultBoolean.Default when unspecified and DefaultBoolean.False to not allow header cells to merge. + + + + Gets or sets whether conditional formatting rules applied to columns are preserved in the exported document.Only available in data-aware export mode. + + A value that specifies whether conditional formatting rules are preserved in the exported document. The DefaultBoolean.Default value is equivalent to True. + + + + Gets or sets whether the column header panel is anchored to the top of the export document and not scrolled vertically. Only available in data-aware export mode. + + A value that specifies whether the column header panel is anchored to the top of the export document + + + + Gets or sets whether left fixed columns enabled in a grid control are fixed in the exported document.Only available in data-aware export mode. + + A value that specifies whether column anchoring is enabled in the exported document. + + + + Gets or sets whether data groups are exported from the source control to the output document. Only available in data-aware export mode. + + A value that specifies whether data groups are exported from the source control to the output document. + + + + Gets or sets whether hyperlinks are exported.Only available in data-aware export mode. + + A value that specifies whether hyperlinks are exported to the resulting document. + + + + Gets or sets whether combo-box and lookup columns’ lookup values are exported.Only available in data-aware export mode. + + A value that specifies whether lookup values of combo-box and lookup columns are exported. + + + + Gets or sets whether columns’ sorting and filtering functionality is enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether the sorting and filtering functionality is enabled for columns in the exported document. + + + + Gets or sets whether sparklines are exported.Only available in data-aware export mode. + + A value that specifies whether sparklines are exported. + + + + Gets or sets whether cell formatting (cell appearance and borders) is applied to entire sheet columns or individual sheet cells. Formatting algorithms applied to sheet columns are faster than those applied to individual cells. Only available in data-aware export mode. + + A value that specifies whether cell formatting is applied to entire sheet columns or to individual sheet cells within the range of exported rows. +The DefaultBoolean.Default value is equivalent to True. + + + + Gets or sets whether to set the minimum value for the Icon Set conditional formatting rule explicitly.Only available in data-aware export mode. + + DefaultBoolean.True to specify the conditional formatting rule’s minimum value in the exported document; DefaultBoolean.Default when unspecified and DefaultBoolean.False to leave the rule’s minimum value unassigned. + + + + Gets or sets how bands and columns are arranged in the output worksheet (when exporting from Banded Views).Only available in data-aware export mode. + + A value that identifies the current layout of bands and columns in the output worksheet. + + + + Fires consecutively for each control row when this row is about to be exported. Allows you to skip specific rows if they do not meet your custom criteria. + + + + + Allows you to customize a native Excel table’s settings before export. This event is in effect when the XlsExportOptionsEx.LayoutMode property is set to Table.Only available in data-aware export mode. + + + + + Gets or sets whether a formula exported as total summary excludes cells with group summary values even if group summaries are calculated at runtime as custom summaries.Only available in data-aware export mode. + + True, if the total summary in the exported document is calculated against multiple cell ranges excluding cells with group summary values; otherwise, false. + + + + When exporting to XLS format, this event allows you to customize a cell in the output document. Only available in data-aware export mode. + + + + + Allows you to customize an individual column in the exported document - change its width, formatting, collapse the group containing the column or hide the column. + + + + + Allows you to add a footer to the output document. Only available in data-aware export mode. + + + + + Allows you to add a header to the output document.Only available in data-aware export mode. + + + + + Allows you to customize the output document’s settings. Only available in data-aware export mode. + + + + + Allows you to apply filters to the exported document’s columns.Only available in data-aware export mode. + + + + + Gets or sets the export document’s culture which defines numeric and date-time data formatting settings. Only available in data-aware export mode. + + The export document’s culture. + + + + This property is not supported by the class. Use the XlsExportOptionsEx.AllowHyperLinks property instead.Only available in data-aware export mode. + + + + + Fires repeatedly while the data is being exported.Only available in data-aware export mode. + + + + + Gets or sets the export type - WYSIWYG or Data Aware. + + The enumeration member. + + + + Gets or sets data groups’ expanded state in the exported document. Only available in data-aware export mode. + + A value that specifies the expanded state of data groups in the output document. + + + + Gets or sets whether data is exported in regular mode or as a native Excel table.Only available in data-aware export mode. + + A value that specifies whether data is exported in regular mode or as a native Excel table. The default value is Standard. + + + + Gets or sets whether band headers are visible in the exported document. This option is in effect when exporting from Banded Grid Views if the XlsExportOptionsEx.BandedLayoutMode option is set to Default. Only available in data-aware export mode. + + A value that specifies whether band headers are visible in the exported document. + + + + Gets or sets whether column headers are visible in the exported document.Only available in data-aware export mode. + + A value that specifies whether column headers are visible in the exported document. + + + + Gets or sets whether group summaries are enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether group summaries are enabled in the exported document. + + + + Gets or sets whether a title is displayed for each print preview page of the exported document. Only available in data-aware export mode. + + A value that specifies whether a title is displayed for each print preview page of the exported document. + + + + Gets or sets whether total summaries are enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether total summaries are enabled in the exported document. + + + + Allows you to hide certain summary footers (or certain multi-line summary footers’ lines) from the exported document.Only available in data-aware export mode. + + + + + Gets or sets whether the Count summary function takes all cells into account or only non-blank cells when exporting to Excel format.Only available in data-aware export mode. + + true, if non-blank and blank cells are counted; false if non-blank cells are only counted. The default value is false. + + + + Gets or sets whether the source control cells with Empty Strings are exported as Blank cells in Excel format.Only available in data-aware export mode. + + true, to export the source control cells with Empty Strings as Blank cells; otherwise, false. The default is false. + + + + Gets or sets whether column values or column expressions are exported for unbound (calculated) columns.Only available in data-aware export mode. + + A value that specifies whether column values or column expressions are exported for unbound (calculated) columns. The default value is AsValue. + + + + Provides data for the PrintingSystemBase.XlSheetCreated event. + + + + + Initializes a new instance of the class with the specified settings. + + An integer value, specifying the Excel sheet index number. This value is assigned to the XlSheetCreatedEventArgs.Index property. + A value, specifying the Excel sheet name. This value is assigned to the XlSheetCreatedEventArgs.SheetName property. + + + + Specifies the Excel sheet index number. + + An integer value. + + + + Specifies the Excel sheet name. + + A value. + + + + Lists the available XLSX export modes. + + + + + A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single XLSX file. + + + + + A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting XLSX file only once, at the beginning and at the end of the document. + + + + + A document is exported to a single file, page-by-page. In this mode, each page is exported to an individual sheet of the same XLSX file. + + + + + Contains options which define how a document is exported to XLSX format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A object, which specifies a format in which data values should be saved. This value is assigned to the XlExportOptionsBase.TextExportMode property. + true, to show the grid lines in the resulting XLSX file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true, to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + true to fit the output document to the page width when printing. This value is assigned to the XlExportOptionsBase.FitToPrintedPageWidth property. + + + + Initializes a new instance of the class with the specified text export mode, grid lines and hyperlink settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLSX file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + true to export hyperlinks; otherwise, false. This value is assigned to the XlExportOptionsBase.ExportHyperlinks property. + + + + Initializes a new instance of the class with the specified text export mode and grid lines settings. + + A object, which specifies a format in which data values should be saved. + true to show the grid lines in the resulting XLSX file; otherwise, false. This value is assigned to the XlExportOptionsBase.ShowGridLines property. + + + + Initializes a new instance of the class with the specified text export mode. + + A object, which specifies a format in which data values should be saved. + + + + Copies all the settings from the object passed as a parameter. + + An object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a System.ArgumentNullException will be thrown. + + + + Specifies whether the source is exported as a single XLSX file or multiple files, and whether each page is exported as a separate worksheet. + + An enumeration value, representing the XLSX export mode. + + + + Gets or sets the range of pages to be exported. + + A specifying the range of pages. + + + + Contains options that define how a document is exported to XLSX format in the data-aware export mode. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified text export mode. + + A enumeration value, specifying a format in which data values should be saved. This value is assigned to the TextExportOptionsBase.TextExportMode property. + + + + Fires immediately after a row is added to the output document.Only available in data-aware export mode. + + + + + Gets or sets whether cell merging is enabled for band headers in the exported document.Only available in data-aware export mode. + + A value that specifies whether cell merging is enabled for band headers in the exported document. The DefaultBoolean.Default value is equivalent to DefaultBoolean.True. + + + + Gets or sets whether cell merging is enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether cell merging is enabled in the exported document. + + + + Gets or sets whether the headers of the same name are exported as merged cells. Only available in data-aware export mode. + + DefaultBoolean.True to export the headers of the same name as merged cells; DefaultBoolean.Default when unspecified and DefaultBoolean.False to not allow header cells to merge. + + + + Gets or sets whether conditional formatting rules applied to columns are preserved in the exported document.Only available in data-aware export mode. + + A value that specifies whether conditional formatting rules are preserved in the exported document. The DefaultBoolean.Default value is equivalent to True. + + + + Gets or sets whether the column header panel is anchored to the top of the export document and not scrolled vertically. Only available in data-aware export mode. + + A value that specifies whether the column header panel is anchored to the top of the export document + + + + Gets or sets whether left fixed columns enabled in a grid control are fixed in the exported document.Only available in data-aware export mode. + + A value that specifies whether column anchoring is enabled in the exported document. + + + + Gets or sets whether data groups are exported from the source control to the output document.Only available in data-aware export mode. + + A value that specifies whether data groups are exported from the source control to the output document. + + + + Gets or sets whether hyperlinks are exported.Only available in data-aware export mode. + + A value that specifies whether hyperlinks are exported to the resulting document. + + + + Gets or sets whether combo-box and lookup columns’ lookup values are exported.Only available in data-aware export mode. + + A value that specifies whether lookup values of combo-box and lookup columns are exported. + + + + Gets or sets whether columns’ sorting and filtering functionality is enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether the sorting and filtering functionality is enabled for columns in the exported document. + + + + Gets or sets whether sparklines are exported.Only available in data-aware export mode. + + A value that specifies whether sparklines are exported. + + + + Gets or sets whether cell formatting (cell appearance and borders) is applied to entire sheet columns or individual sheet cells. Formatting algorithms applied to sheet columns are faster than those applied to individual cells. Only available in data-aware export mode. + + A value that specifies whether cell formatting is applied to entire sheet columns or to individual sheet cells within the range of exported rows. +The DefaultBoolean.Default value is equivalent to True. + + + + Gets or sets whether to set the minimum value for the Icon Set conditional formatting rule explicitly.Only available in data-aware export mode. + + DefaultBoolean.True to specify the conditional formatting rule’s minimum value in the exported document; DefaultBoolean.Default when unspecified and DefaultBoolean.False to leave the rule’s minimum value unassigned. + + + + Gets or sets how bands and columns are arranged in the output worksheet (when exporting from Banded Views).Only available in data-aware export mode. + + A value that identifies the current layout of bands and columns in the output worksheet. + + + + Fires consecutively for each control row when this row is about to be exported. Allows you to skip specific rows if they do not meet your custom criteria. + + + + + Allows you to customize a native Excel table’s settings before export. This event is in effect when the XlsxExportOptionsEx.LayoutMode property is set to Table. + + + + + Gets or sets whether a formula exported as total summary excludes cells with group summary values even if group summaries are calculated at runtime as custom summaries.Only available in data-aware export mode. + + True, if the total summary in the exported document is calculated against multiple cell ranges excluding cells with group summary values; otherwise, false. + + + + Allows you to customize a cell in the output document. Only available in data-aware export mode. + + + + + Allows you to customize an individual column in the exported document - change its width, formatting, collapse the group containing the column or hide the column.Only available in data-aware export mode. + + + + + Allows you to customize the footer in the output document. Only available in data-aware export mode. + + + + + Allows you to customize the header in the output document. Only available in data-aware export mode. + + + + + Allows you to customize the output document’s settings. Only available in data-aware export mode. + + + + + Allows you to apply filters to the exported document’s columns.Only available in data-aware export mode. + + + + + Gets or sets the export document’s culture which defines numeric and date-time data formatting settings. Only available in data-aware export mode. + + The export document’s culture. + + + + This property is not supported by the class. Use the XlsxExportOptionsEx.AllowHyperLinks property instead.Only available in data-aware export mode. + + + + + Fires repeatedly while the data is being exported.Only available in data-aware export mode. + + + + + Gets or sets the export type - WYSIWYG or Data Aware. + + The enumeration member. + + + + Gets or sets data groups’ expanded state in the exported document. Only available in data-aware export mode. + + A value that specifies the expanded state of data groups in the output document. + + + + Gets or sets whether data is exported in regular mode or as a native Excel table.Only available in data-aware export mode. + + A value that specifies whether data is exported in regular mode or as a native Excel table. The default value is Standard. + + + + Gets or sets whether band headers are visible in the exported document. This option is in effect when exporting from Banded Grid Views if the XlsxExportOptionsEx.BandedLayoutMode option is set to Default. Only available in data-aware export mode. + + A value that specifies whether band headers are visible in the exported document. + + + + Gets or sets whether column headers are visible in the exported document.Only available in data-aware export mode. + + A value that specifies whether column headers are visible in the exported document. + + + + Gets or sets whether group summaries are enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether group summaries are enabled in the exported document. + + + + Gets or sets whether a title is displayed for each print preview page of the exported document. Only available in data-aware export mode. + + A value that specifies whether a title is displayed for each print preview page of the exported document. + + + + Gets or sets whether total summaries are enabled in the exported document.Only available in data-aware export mode. + + A value that specifies whether total summaries are enabled in the exported document. + + + + Allows you to hide certain summary footers (or certain multi-line summary footers’ lines) from the exported document.Only available in data-aware export mode. + + + + + Gets or sets whether the Count summary function takes all cells into account or only non-blank cells when exporting to Excel format.Only available in data-aware export mode. + + true, if non-blank and blank cells are counted; false if non-blank cells are only counted. The default value is false. + + + + Gets or sets whether the source control cells with Empty Strings are exported as Blank cells in Excel format.Only available in data-aware export mode. + + true, to export the source control cells with Empty Strings as Blank cells; otherwise, false. The default is false. + + + + Gets or sets whether to suppress the exception that is raised if you export more than 16,384 columns to an XLSX file.Only available in data-aware export mode. + + true, to prevent the exception from raising; otherwise, false. + + + + Gets or sets whether to suppress the exception that is raised on attempting to export more than 1,048,576 rows to an XLSX file. Only available in data-aware export mode. + + true, to prevent the exception from raising; otherwise, false. + + + + Gets or sets whether column values or column expressions are exported for unbound (calculated) columns.Only available in data-aware export mode. + + A value that specifies whether column values or column expressions are exported for unbound (calculated) columns. The default value is AsValue. + + + + Lists the values used to specify the compression level of the XPS document. + + + + + XPS document is compressed fast, but with a lower level of compression. + + + + + XPS document is compressed with the best level of compression, but it requires more time. + + + + + XPS document is compressed with a normal level of compression. + + + + + XPS document is not compressed. + + + + + XPS document is compressed very fast, but with the lowest level of compression. + + + + + Contains options which specify the Document Properties of the created XPS file. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the string to be added as a Category property of the resulting XPS file. + + A which stores a Category. + + + + Creates a copy of the current object. + + A object which is a copy of the current object. + + + + Gets or sets the string to be added as a Creator property of the resulting XPS file. + + A which stores a Creator. + + + + Gets or sets the string to be added as a Description property of the resulting XPS file. + + A which stores a Description. + + + + Gets or sets the string to be added as a Keywords property of the resulting XPS file. + + A which stores keywords. + + + + Gets or sets the string to be added as a Subject property of the resulting XPS file. + + A which stores a Subject. + + + + Gets or sets the string to be added as a Title property of the resulting XPS file. + + A which stores a Title. + + + + Gets or sets the string to be added as a Version property of the resulting XPS file. + + A which stores a Version. + + + + Contains options which define how a document is exported to XPS format. + + + + + Initializes a new instance of the class with the default settings. + + + + + Copies all the settings from the object passed as a parameter. + + An object whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets a value specifying the compression level of the XPS document. + + An enumeration level. + + + + Gets the options to be embedded as Document Properties of the created XPS file. + + An object which contains Document Properties options. + + + + Specifies the engine that renders PDF content. + + + + + Automatically detects the rendering engine based on the platform: Skia on Linux; GDI+ on Azure. + + + + + The DirectX rendering engine. + + + + + The GDI+ rendering engine. + + + + + The Skia rendering engine. + + + + + The base for classes that provide functionality to print reports. + + + + + Applies the defined page settings. + + Current page settings. + An enumeration value. + The size of a custom paper. + The margins (in hundredths of an inch) of a report page. + The minimum margins. + true if the page orientation is landscape; otherwise, false. + The name of a custom paper. + true to apply page settings; otherwise, false. + + + + Applies the defined page settings. + + Current page settings. + An enumeration value. + The size of a custom paper. + The margins (in hundredths of an inch) of a report page. + The minimum margins. + true if the page orientation is landscape; otherwise, false. + true to apply page settings; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + The minimum margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + The name of the custom paper which is used in the printer that the document is going to be printed on. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + The minimum margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + Specifies one of the standard paper sizes. + true to print a page in landscape orientation; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + Specifies one of the standard paper sizes. + The name of the custom paper which is used in the printer that the document is going to be printed on. + true to print a page in landscape orientation; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + + + + Assigns multiple page parameter simultaneously. + + The document margins. + The minimum margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + The name of the custom paper which is used in the printer that the document is going to be printed on. + + + + Assigns multiple page parameter simultaneously. + + Document margins. + Minimum margins. + Specifies one of the standard paper sizes. + The page size. + true to print a page in landscape orientation; otherwise, false. + + + + For internal use. + + + + + Assigns the specified page settings with the specified minimum margins. + + A object, providing the page settings. + A object that specifies the minimum value of the document margins. + + + + Assigns the default page settings to a report document. + + + + + Assigns the printer settings to the current page settings according to the specified value. + + A value which specifies the name of the printer. + A value which specifies the name of the custom paper which is used in the printer that the document is going to be printed on. + A object specifying which of the printer settings should be assigned. + + + + Gets or sets the bottom page margin. + + The bottom page margin, in hundredths of an inch. + + + + Gets or sets the bottom page margin. + + A value. + + + + Gets the bounds of a report page, taking into account the page orientation specified by the XtraPageSettingsBase.Landscape property. + + A that represents page length and width (in hundredths of an inch). + + + + For internal use. + + + + + Specifies the default margins for a report’s pages. + + + + + Specifies the default minimum margins for a report’s pages. + + + + + Represents the default paper type () used in a report. + + + + + Disposes of the object. + + + + + Gets or sets a value indicating whether the page orientation is landscape. + + true if the page orientation is landscape; otherwise, false. + + + + Gets or sets the left page margin. + + The left page margin, in hundredths of an inch. + + + + Gets or sets the left page margin. + + A value. + + + + Gets the margins of a report page. + + + + + Gets the margins of a report page measured in three hundredths of an inch. + + The margins (measured in 1/300 of an inch) of a report page. + + + + Gets the minimum size allowed for a report’s margins. + + + + + Gets or sets the type of paper for the document. + + A value that defines the paper kind. + + + + Gets or sets the name of the custom paper used in the printer to be used in printing the document. + + A value, specifying the name of the paper. + + + + Gets or sets the name of the printer to use when printing the document. + + A value which represents the name of the printer to use. + + + + Restores the document page settings from the specified stream. + + A object. + + + + Restores the document page settings from the specified XML file. + + A value. + + + + Gets or sets the right page margin. + + The right page margin, in hundredths of an inch. + + + + Gets or sets the right page margin. + + A value. + + + + Specifies whether the document is supposed to be printed on roll paper (i.e., as a single uninterrupted page). + + true to provide a continuous document layout, suited for roll paper printing; otherwise false. + + + + Saves the document page settings to the specified stream. + + A object. + + + + Saves the document page settings to the specified XML file. + + A value. + + + + Gets or sets the top page margin. + + The top page margin, in hundredths of an inch. + + + + Gets or sets the top page margin. + + A value. + + + + Gets the rectangle on the page (in hundredths of an inch) that can contain data. + + A object representing the rectangle on a page which can contain data. + + + + Gets the width and height (in hundredths of an inch) of the page region that can contain data. + + The width and height (in hundredths of an inch) of the page region that can contain data. + + + + Gets the width and height (in pixels) of the page region that can contain data. + + The width and height (in pixels) of the page region that can contain data. + + + + A visual brick that contains a zip code. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IBrickOwner interface. + + + + Gets the text string, containing the brick type information. + + A string, characterizing the brick’s type. Always returns “ZipCode”. + + + + Gets or sets the width of the lines that the numbers in a zip code brick are drawn with. + + An integer value specifying the width (in pixels) of a ‘s lines. + + + + Overrides the VisualBrick.TextValue property to hide it. + + A . + + + + Overrides the VisualBrick.TextValueFormatString property to hide it. + + A value. + + + + Overrides the VisualBrick.XlsxFormatString property to hide it. + + A value. + + + + Contains classes which provide printing and exporting functionality for standard Windows Forms controls. + + + + + The base class for classes that provide the composite link functionality. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified Printing System. + + A object which specifies the printing system used to draw the current link. This value is assigned to the CompositeLinkBase.PrintingSystemBase property. + + + + Initializes a new instance of the class with the specified container. + + An object implementing the interface which specifies the owner container of a class instance. + + + + Specifies the indent between the printed content of individual links. + + An integer value, specifying the blank space between the links’ content. + + + + Used to export each link contained in the Composite Link to a separate page (e.g., when exported to PDF, Excel or RTF files). + + + + + Gets a collection of links of a object. + + A object. + + + + Gets or sets the Printing System used to create and print a document for this link. + + A class descendant. + + + + Provides the general functionality to print controls that implement the interface. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified printing system. + + A object which specifies the printing system used to draw the current link. This value is assigned to the PrintableComponentLink.PrintingSystem property. + + + + Initializes a new instance of the class with the specified container. + + An object implementing the interface which specifies the owner container of a class instance. + + + + Gets or sets a user implementation printed via the current link. + + An user implementation. + + + + Gets the type of the object to be printed by the link. + + A class descendant representing the type of object that will be printed by this link. This class should implement the interface. + + + + Sets the object to be printed by this link. + + A object implementing the interface. + + + + Contains classes that implement functionality specific to XtraReports. + + + + + Provides types that describe binding expressions for report parameters‘ properties. + + + + + Initializes a new instance of the class. + + + + + Stores a binding expression that is parsed and processed to specify a report control or parameter‘s property value. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the parameter’s property name and binding expression. + + The name of a parameter’s property to which an expression is bound. Only the property is supported. + A binding expression that is parsed and processed to specify the parameter’s property value. + + + + A binding expression that is parsed and processed to specify a control or parameter’s property value. + + A binding expression that is parsed and processed to specify a control or parameter’s property value. + + + + The name of the report control or parameter‘s property to specify an for. + + The name of a property to specify an expression for. Only the property is supported for parameters. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + + + + Provides access to individual items in the collection by their names. + + An item with the specified name. + A binding expression for a parameter‘s property value. + + + + The base class for the collection. + + A descendant of the class. + + + + Initializes a new instance of the class. + + + + + Appends the elements from the specified array to the collection. + + An array of objects. + + + + Appends the elements from the specified collection to the collection. + + A collection of objects. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + When implemented in a class, helps you access, add and remove document pages. + + + + + Adds specified pages to the end of the report document’s page collection. + + The page collection to be added to the end of the report document’s page collection. + + + + Returns the index of the page whose Page.ID is specified as a parameter. + + The page ID. + The page index that corresponds to the page ID passed as a parameter. + + + + Inserts a specified page at a specified position. + + The position to insert a page. + The page to insert. + + + + Returns the report document’s page count. + + A integer value specifying the report document’s page count. + + + + Removes a page at a specified position. + + The position at which to remove a page. + + + + For internal use. Provides the basic functionality for the class. + + + + + For internal use. + + + + + If implemented by a class, interrupts the process of document creation. + + + + + Contains classes that are used to handle parameters in XtraReports. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + Provides settings for the storage that contains the list of predefined parameter values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the data adapter for the storage that contains the report parameter’s predefined values. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A value. + + + + Specifies the data member name for the storage that contains the report parameter‘s predefined values. + + A value. + + + + Specifies the data source for the storage that contains the report parameter’s predefined values. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A value. + + + + Specifies the data member for the storage that contains the report parameter’s display name. + + A value. + + + + Specifies the name of the field that is used to sort parameter values in the lookup editor. + + The name of the field that is used to sort parameter values in the lookup editor. + + + + Specifies the sort order for the parameter values in the lookup editor. + + The sort order for the parameter values in the lookup editor. + + + + Specifies whether to filter cascading parameters on the database level (server side) or on the application level (client side). + + true to filter cascading parameters on the database level; false to apply a filter on the application level. + + + + The name of the field that stores the report parameter‘s values. + + A value. + + + + Contains methods that allow you to create and customize a parameter group. + + + + + Creates a group. + + An action that customizes the group. + A builder, so you can chain additional methods that customize the panel. + + + + Adds a report parameter editor to the UI. Accepts a report parameter object. + + A report parameter object. + An action that customizes the report parameter editor. + A group builder, so you can chain additional methods that customize the group. + + + + Adds a report parameter editor to the UI. Accepts a report parameter name. + + A report parameter name. + An action that customizes the report parameter editor. + A group builder, so you can chain additional methods that customize the group. + + + + Creates a separator. + + A group builder, so you can chain additional methods that customize the group. + + + + Creates a group, sets its title, and begins group customization. + + A group title. + A group builder, so you can chain additional methods that customize the group. + + + + Adds a parameter editor to the UI and begins editor customization. Accepts a report parameter object. + + A report parameter object. + Specifies label location relative to the editor. + A parameter builder, so you can chain additional methods that customize the parameter editor. + + + + Adds a parameter editor to the UI and begins editor customization. Accepts a report parameter name. + + A parameter name. + Specifies label location relative to the editor. + A parameter builder, so you can chain additional methods that customize the parameter editor. + + + + Creates a separator. + + A separator builder. + + + + Ends Parameters panel customization. + + + + + Ends group customization. + + A builder, so you can chain additional methods that customize the panel. + + + + Returns a builder for a group that contains the specified parameter. Applies a customization action to the group. + + A report parameter object. + A customization action. + A group builder, so you can chain methods that customize the group. + + + + Returns a builder for a group that contains the specified parameter. + + A report parameter object. + A group builder, so you can chain methods that customize the group. + + + + Returns a group builder by index. Applies a customization action to the group. + + A group index. + A customization action. + A group builder, so you can chain additional methods that customize the group. + + + + Returns a group builder by index. + + A group index. + A group builder, so you can chain methods that customize the group. + + + + Returns a builder for a group that contains a parameter with the specified name. Applies a customization action to the group. + + A parameter name. + A customization action. + A group builder, so you can chain methods that customize the group. + + + + Returns a builder for a group that contains a parameter with the specified name. + + A parameter name. + A group builder, so you can chain methods that customize the group. + + + + Applies a customization action to the specified parameter. + + A report parameter object. + A customization action. + A builder, so you chain additional methods that customize the panel. + + + + Returns a parameter builder. Accepts a report parameter object. + + A report parameter object. + A parameter builder, so you chain methods that customize the parameter editor. + + + + Applies a customization action to the parameter with the specified index. + + A parameter index. + A customization action. + A builder, so you chain additional methods that customize the panel. + + + + Returns a parameter builder by index. + + A parameter index. + A parameter builder, so you chain methods that customize the parameter editor. + + + + Applies a customization action to the parameter with the specified name. + + A parameter name. + A customization action. + A builder, so you chain additional methods that customize the panel. + + + + Returns a parameter builder. Accepts a parameter name. + + A parameter name. + A parameter builder, so you chain methods that customize the parameter editor. + + + + Removes a group that contains the specified parameter. + + A report parameter object. + A builder, so you chain methods that customize the panel. + + + + Removes a group by index. + + A group index. + A builder, so you chain methods that customize the panel. + + + + Removes a group that contains a parameter with the specified name. + + A parameter name. + A builder, so you chain additional methods that customize the panel. + + + + Removes a parameter editor from the UI. Accepts a parameter object. + + A report parameter object. + A builder, so you chain methods that customize the panel. + + + + Removes a parameter editor from the UI. + + A parameter index. + A builder, so you chain methods that customize the panel. + + + + Removes a parameter editor from the UI. Accepts a parameter name. + + A parameter name. + A builder, so you chain methods that customize the panel. + + + + Removes a separator. + + A separator index. + A builder, so you chain methods that customize the panel. + + + + Specifies whether group borders are visible. + + true, to make group borders visible; otherwise, false. + A group builder, so you can chain additional methods that customize the group. + + + + Specifies whether a group is expanded or collapsed. + + true, to expand the group; otherwise, false. + A group builder, so you can chain additional methods that customize the group. + + + + Specifies whether group parameters are placed vertically or horizontally. + + The orientation type. + A group builder, so you can chain additional methods that customize the group. + + + + Specifies whether to show the group’s expand/collapse button. + + true, to show the button; otherwise, false. + A group builder, so you can chain additional methods that customize the group. + + + + Specifies a group title. + + A group title. + A group builder, so you can chain additional methods that customize the group. + + + + Specifies whether a group title is visible. + + true, to make the title visible; otherwise, false. + A group builder, so you can chain additional methods that customize the group. + + + + For internal use. + + + + + For internal use. + + + + + Contains methods that allow you to access parameter look-up values. + + + + + Returns a collection of parameter look-up values. + + Settings for a source of the parameter look-up values. + A object. + An object that implements the interface. + A collection of parameter look-up values. + + + + Returns an updated collection of parameter values available in a look-up editor. + + A value, specifying the previously selected parameter value. + A collection of objects, specifying the look-up values available for the parameter. + A value, specifying the currently selected parameter value. + + + + The base class for classes that provide the look-up editor settings for report parameters. + + + + + Specifies the data adapter that is used to provide parameter values to the lookup editor. + + A value. + + + + Specifies the data member that is used to provide parameter values to the lookup editor. + + A value. + + + + Specifies the data source that is used to provide parameter values to the lookup editor. + + A value. + + + + Specifies the filter criteria applied to the object. + + A value, specifying the filter string. + + + + A parameter’s value that is shown in its look-up editor for end-users. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A value. + A value. + + + + Creates a new instance, which is a copy of the current instance. + + A new instance, which is a copy of the current instance. + + + + For internal use. + + + + + Specifies the parameter value description. + + A value. + + + + “Description“ + + + + + For internal use. + + A value. + + + + Specifies the parameter value. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A value. + + + + “Value“ + + + + + A collection of objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Appends an array of look-up values to the collection. + + An array of objects to append to the collection. + + + + Lists orientation types for a report parameter and group. + + + + + Places elements horizontally. + + + + + Places elements vertically. + + + + + A report parameter. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether to treat an empty field as null. + + true, to treat an empty field as null; otherwise, treat an empty field as string.empty. + + + + Specifies a parameter description. This description is displayed beside a parameter editor in the Parameters panel. + + A parameter description. + + + + Specifies whether a parameter editor is enabled or disabled in the Parameters panel. + + true, to enable a parameter editor; otherwise; false. + + + + Provides access to the parameter’s expression bindings collection. + + The parameter’s expression bindings collection. + + + + Specifies the look-up editor settings of the parameter. + + A object. + + + + Specifies whether you and end users can pass multiple values to a report parameter. + + true to make a parameter multivalue; otherwise, false. + + + + Specifies a name by which you can reference a parameter in a report. + + A parameter name. + + + + For internal use. + + A value. + + + + For internal use. Specifies the type of the value associated with the parameter. + + A enumeration value. + + + + For internal use. + + A . + + + + Specifies whether to use all values of a multivalue parameter as defaults. + + true to use all values as defaults; otherwise, false. + + + + Specifies the object that contains data about the report parameter. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + An that contains data about the report parameter. + + + + Specifies a parameter type. + + A parameter type. + + + + Specifies a parameter value. + + A parameter value. + + + + For internal use. Stores additional information relating to the parameter‘s value. + + A value. + + + + Gets or sets settings used to generate predefined values for a report parameter. + + Settings used to generate predefined values for a report parameter. + + + + Specifies whether a parameter editor is visible in the Parameters panel. + + true to show a parameter editor; otherwise, false. + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class with the default settings. + + + + + Appends an array of parameters to the collection. + + An array of objects to append to the collection. + + + + Provides access to individual items in the collection by their names. + + A value specifying the name of the parameter to get. + A object which represents the parameter with the specified name. + + + + Represents a class containing information about a specific parameter and its editor. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets an editor, used to enter a parameter’s value. + + A class descendant. + + + + For internal use. + + + + + Provides access to the parameter associated with the current object. + + A object. + + + + Contains methods that allow you to customize a parameter layout. + + + + + Ends parameter editor customization. + + A group builder, so you can chain additional methods that customize the group. + + + + Specifies whether a parameter name and editor should be placed vertically or horizontally. + + The orientation type. + A parameter builder, so you can chain additional methods that customize the parameter. + + + + The base class for . + + + + + Discards all customization actions applied to the Parameters panel. + + The base class for . + + + + Ends Parameters panel customization. + + + + + Provides data for the XtraReport.ParametersRequestBeforeShow and XtraReport.ParametersRequestSubmit events. + + + + + Provides access to information about the requested parameters. + + An array of objects. + + + + Provides data for the XtraReport.ParametersRequestValueChanged event. + + + + + Contains information about the parameter, which value was changed. + + + + + Specifies the type of the value that should be passed to a parameter. + + + + + The parameter returns a Boolean value, corresponding to the type. + + + + + The parameter returns a date-time value, corresponding to the type. + + + + + The parameter returns a decimal value, corresponding to the type. + + + + + The parameter returns a double-precision floating-point number, corresponding to the type. + + + + + The parameter returns a floating-point value, corresponding to the type. + + + + + The parameter returns an integer value, corresponding to the type. + + + + + The parameter returns a 64-bit signed integer value, corresponding to the type. + + + + + The parameter returns a string value, corresponding to the type. + + + + + The base class for the and classes. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + A range parameter‘s nested end parameter in a report. + + + + + Initializes a new instance of the class. + + + + + A static class that provides access to the list of predefined ranges that are displayed in the date range parameter‘s editor in Print Preview. + + + + + Provides access to the list of predefined date ranges that are available in date range parameters’ editors in Print Preview. + + The dictionary of predefined ranges that are available in parameters’ editors. + + + + Appends an item to the list of predefined date ranges. + + The predefined date range’s name. + The function that returns the predefined date range’s start date. + The function that returns the predefined date range’s end date. + + + + Provides the nested start and end parameters for a report‘s date range parameter. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified and values. + + A parameter range’s start parameter. + A parameter range’s end parameter. + + + + A range parameter’s nested end parameter. + + A range parameter’s end value. + + + + A range parameter’s nested start parameter. + + A range parameter’s start value. + + + + A range parameter‘s nested start parameter in a report. + + + + + Initializes a new instance of the class. + + + + + Contains methods that allow you to add a separator between parameters and groups. + + + + + Ends separator customization. + + A group builder, so you can chain additional methods that customize the panel. + + + + Provides access to a report parameter‘s list of static values. + + + + + Initializes a new instance of the class with the default settings. + + + + + Overrides the LookUpSettings.DataAdapter property to hide it. + + A value. + + + + Overrides the LookUpSettings.DataMember property to hide it. + + A value. + + + + Overrides the LookUpSettings.DataSource property to hide it. + + A value. + + + + Stores a report parameter’s list of static values. + + A list of a report parameter’s static values. + + + + A base class for classes that specify a report parameter‘s predefined values. + + + + + For internal use. + + The type of an object that the contains. + + + + For internal use. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Contains classes that enable you to convert a to an . + + + + + Provides options that control the layout of an that is generated by a based on a ‘s data. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether or not column widths are automatically modified so that the width of total columns matches the width of a View. + + true, to enable the auto width feature; otherwise, false. + + + + Specifies whether even rows in the resulting report are painted using the appearance settings provided by the GridViewPrintAppearances.EvenRow property. + + DefaultBoolean.True or DefaultBoolean.Default to render even rows in the report using the corresponding grid view appearance settings; otherwise DefaultBoolean.False. + + + + Specifies whether odd rows in the resulting report are painted using the appearance settings provided by the GridViewPrintAppearances.OddRow property. + + DefaultBoolean.True or DefaultBoolean.Default to render odd rows in the report using the corresponding grid view appearance settings; otherwise DefaultBoolean.False. + + + + Specifies whether to add band headers to the report. This option is in effect when the source object supports bands ( and ). + + DefaultBoolean.True or DefaultBoolean.Default to add band headers to the report; otherwise DefaultBoolean.False. + + + + Specifies whether to add column headers to the report. + + DefaultBoolean.True or DefaultBoolean.Default to add column headers to the report; otherwise DefaultBoolean.False. + + + + Specifies whether to include group rows in the report. + + DefaultBoolean.True or DefaultBoolean.Default to include group rows in the report; otherwise DefaultBoolean.False. + + + + Specifies whether to add group footers to the report. + + DefaultBoolean.True or DefaultBoolean.Default to add group footers to the report; otherwise DefaultBoolean.False. + + + + Specifies the visibility of horizontal grid lines in the report. + + DefaultBoolean.True or DefaultBoolean.Default to add horizontal grid lines to the report; otherwise DefaultBoolean.False. + + + + Specifies whether to add the summary footer to the report. + + DefaultBoolean.True or DefaultBoolean.Default to add the summary footer to the report; otherwise DefaultBoolean.False. + + + + Specifies the visibility of vertical grid lines in the report. + + DefaultBoolean.True or DefaultBoolean.Default to add vertical grid lines to the report; otherwise DefaultBoolean.False. + + + + Specifies whether dedicated print appearance settings (GridView.AppearancePrint) or regular appearance settings (GridView.Appearance) are used when generating a report. + + DefaultBoolean.True to use print appearance settings; DefaultBoolean.False or DefaultBoolean.Default to use regular appearance settings. + + + + Contains classes that implement the basic functionality of XtraReports. + + + + + Lists the horizontal anchoring styles available for a report control. + + + + + Anchores a control to the left and right edges of its container. + + + + + Anchors a control to the left edge of its container. + + + + + Identical to the Left member. + + + + + Anchors a control to the right edge of its container. + + + + + For internal use. Provides the basic functionality for the class. + + + + + For internal use. If implemented by a class, stops displaying the report. + + + + + For internal use. If implemented by a class, stops displaying the report. + + + + + Gets the information about the report’s parameters. + + A list of the objects that contain information about a specific parameter and its editor. + + + + For internal use. If implemented by a class, prints the current document. + + + + + For internal use. If implemented by a class, prints the current document to the specified printer. + + A representing the name of the printer on which to print the report. + + + + If implemented by a class, invokes the Print dialog. + + true if the user clicks OK in the dialog box; false if the user clicks Cancel; otherwise null (Nothing in Visual Basic). + + + + If implemented by a class, invokes a Page Setup dialog + + A value. + true if the user clicks OK in the dialog box; false if the user clicks Cancel; otherwise null (Nothing in Visual Basic). + + + + For internal use. If implemented by a class, invokes the Print Preview Form which shows the print preview of the report document. + + + + + For internal use. If implemented by a class, invokes the Print Preview Form which shows the print preview of the report document. + + A value. + + + + For internal use. If implemented by a class, invokes the Print Preview Form which modally shows the print preview of the report document. + + + + + For internal use. If implemented by a class, invokes the Print Preview Form which modally shows the print preview of the report document. + + A value. + + + + For internal use. If implemented by a class, invokes the Ribbon Print Preview showing the report document. + + + + + For internal use. If implemented by a class, invokes the Ribbon Print Preview showing the report document. + + A value. + + + + For internal use. If implemented by a class, invokes the Ribbon Print Preview Form which modally shows the print preview of the report. + + + + + For internal use. If implemented by a class, invokes the Ribbon Print Preview Form which modally shows the print preview of the report. + + A value. + + + + Specifies the direction of a line drawn inside an control. + + + + + A line is drawn between the upper-left and bottom-right corners of the rectangle occupied by the control. + + + + + A line is drawn horizontally. + + + + + A line is drawn between the bottom-left and upper-right corners of the rectangle occupied by the control. + + + + + A line is drawn vertically. + + + + + Specifies whether or not the page band should be printed on the same pages with Report Header and Report Footer bands. + + + + + A band is printed on all report pages in the ordinary manner. + + + + + A band is hidden if a page contains a Report Footer. + + + + + A band is hidden if a page contains a Report Header. + + + + + A band is hidden if a page contains a Report Header or Report Footer. + + + + + Enables publishing a report in a Windows Forms application by creating a . + + + + + Enables publishing a report in a Windows Forms application. + + An . + A . + + + + Specifies how a control anchors to the top and/or bottom edges of its container. + + + + + Anchores a control to the top and bottom edges of its container. + + + + + Anchores a control to the bottom edge of its container. + + + + + Does not anchor a control to the edges of its container. + + + + + Anchores a control to the top edge of its container. + + + + + Enables you to convert value types and adjust values to different measure units. + + + + + Initializes a new instance of the class with the specified DPI. + + A value. + + + + Adjusts the coordinates of a point calculated for the specified DPI according to the current DPI. + + A structure. + A value, specifying the initial DPI setting. + A structure. + + + + Adjusts the location and size of a rectangle calculated for the specified DPI according to the current DPI. + + A structure. + A value, specifying the initial DPI setting. + A structure. + + + + Adjusts the size calculated for the specified DPI according to the current DPI. + + A structure. + A value, specifying the initial DPI setting. + A structure. + + + + Adjusts the integer value calculated for the specified DPI according to the current DPI. + + An integer value. + A value, specifying the initial DPI setting. + An integer value. + + + + Adjusts the document margins according to the specified DPI setting. + + A object. + A value, specifying the initial DPI setting. + A value, specifying the required DPI setting. + A object. + + + + Adjusts the coordinates of a point calculated for the current DPI according to the specified DPI. + + A structure. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the location and size of a rectangle calculated for the current DPI according to the specified DPI. + + A structure. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the size calculated for the current DPI according to the specified DPI. + + A structure. + A value, specifying the required DPI setting. + A structure. + + + + Adjusts the integer value calculated for the current DPI according to the specified DPI. + + An integer value. + A value, specifying the required DPI setting. + An integer value. + + + + Returns the current DPI value. + + A value. + + + + Converts the specified string array to a string value that delimits the array values with the “\r\n” sequence. + + An array of values. + A value. + + + + Splits the specified string into an array of substrings at the positions defined by the “\r\n” sequence. + + A value. + An array of values. + + + + Adjusts the specified value to a corresponding value. + + A enumeration value. + A enumeration value. + + + + Adjusts the specified value to a corresponding value. + + A enumeration value. + A enumeration value. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.dll b/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.dll new file mode 100644 index 0000000..43dc46a Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.xml b/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.xml new file mode 100644 index 0000000..ed2959c --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Sparkline.v23.2.Core.xml @@ -0,0 +1,445 @@ + + + + DevExpress.Sparkline.v23.2.Core + + + + + Contains classes required for DevExpress sparklines. + + + + + The Area sparkline view. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies the opacity (0-255) of the area sparkline. + + A value from 0 (transparent) to 255 (opaque). + + + + Copies all the settings from the object passed as the parameter. + + A object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets the type of the sparkline view. + + Always SparklineViewType.Area. + + + + Invokes the Visit method of the specified visitor for the current object. + + An object implementing the interface. + + + + The Bar sparkline view. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the type of the sparkline view. + + Always SparklineViewType.Bar. + + + + Invokes the Visit method of the specified visitor for the current object. + + An object implementing the interface. + + + + The base for Bar and WinLoss sparkline views. + + + + + Copies all the settings from the object passed as the parameter. + + A object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Specifies the distance between two bars of a bar sparkline. + + An integer value (in pixels). + + + + Interface implementing the Visitor pattern. + + + + + Performs the operation as required by the Visitor and the View, as defined in the Visitor pattern. + + An object for which the operation is performed. + + + + Performs the operation as required by the Visitor and the View, as defined in the Visitor pattern. + + An object for which the operation is performed. + + + + Performs the operation as required by the Visitor and the View, as defined in the Visitor pattern. + + An object for which the operation is performed. + + + + Performs the operation as required by the Visitor and the View, as defined in the Visitor pattern. + + An object for which the operation is performed. + + + + The Line sparkline view. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the actual color of a sparkline marker. + + A value that is the actual marker color. + + + + Copies all the settings from the object passed as the parameter. + + A object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets whether anti-aliasing (smoothing) is applied to the line view. + + True to apply anti-aliasing to the line view; False to disable anti-aliasing. + + + + Gets or sets the size of an end point’s marker. + + An integer value specifying the marker size, in pixels. + + + + Specifies the width of a line in a . + + An integer value specifying the line width (in pixels). + + + + Gets or sets the color to draw line markers. + + A that defines the color to draw line markers. + + + + Gets or sets the size of markers for data points in a line sparkline. + + An integer value specifying the marker size, in pixels. + + + + Gets or sets the marker size of a data point that has the maximum value among all data points. + + An integer value specifying the marker size, in pixels. + + + + Gets or sets the marker size of a data point that has the minimum value among all data points. + + An integer value specifying the marker size, in pixels. + + + + Gets or sets the marker size of all data points that have negative values (less than 0). + + An integer value specifying the marker size, in pixels. + + + + Sets size for all markers of a sparkline. + + An integer value specifying the new size for sparkline markers (in pixels). + + + + Gets or sets a value specifying the visibility of point markers on a sparkline. + + true to show markers for each data point; false to hide them. + + + + Gets or sets the size of a start point’s marker. + + An integer value specifying the marker size, in pixels. + + + + Gets the type of the sparkline view. + + Always SparklineViewType.Line. + + + + Invokes the Visit method of the specified visitor for the current object. + + An object implementing the interface. + + + + Represents a range to be used in DevExpress Sparkline controls. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified minimum and maximum limits. + + A value, specifying the minimum limit. This value is assigned to the SparklineRange.Limit1 property. + A value, specifying the maximum limit. This value is assigned to the SparklineRange.Limit2 property. + + + + Gets or sets a value indicating whether or not range limits should be calculated automatically. + + true to calculate range limits automatically; false to use the SparklineRange.Limit1 and SparklineRange.Limit2 property values. + + + + Gets or sets a value specifying the first limit of the range. + + A value that specifies the first limit. + + + + Gets or sets a value specifying the second limit of the range. + + A value that specifies the second limit. + + + + This event is hidden, because it is not appropriate for the class. + + + + + Returns the textual representation of the . + + A value which is the textual representation of the . + + + + The base class for sparkline views. + + + + + Gets the actual color of a sparkline. + + A value that is the actual sparkline color. + + + + Gets the actual color of a sparkline end point. + + A value that is the actual point color. + + + + Gets the actual color of a sparkline maximum point. + + A value that is the actual point color. + + + + Gets the actual color of a sparkline minimum point. + + A value that is the actual point color. + + + + Gets the actual color of sparkline negative points. + + A value that is the actual point color. + + + + Gets the actual color of a sparkline start point. + + A value that is the actual point color. + + + + Copies all the settings from the object passed as the parameter. + + A object (which is the descendant) whose settings are assigned to the current object. If null (Nothing in Visual Basic), then a will be thrown. + + + + Gets or sets the color to draw a sparkline. + + A that defines the color to draw a sparkline. + + + + Creates a sparkline view of the specified type. + + A enumeration value specifying the type of view to create. + A class descendant. + + + + Gets or sets the color to draw the end point of a sparkline. + + A that defines the color to draw the end point. + + + + Gets or sets a value specifying whether or not to highlight the end point of a sparkline. + + true, to highlight the end point; otherwise, false. + + + + Gets or sets a value specifying whether or not to highlight a sparkline point that has the highest value among all points. + + true, to highlight a point with the maximum value; otherwise, false. + + + + Gets or sets a value specifying whether or not to highlight a sparkline point that has the lowest value among all points. + + true, to highlight a point with the minimum value; otherwise, false. + + + + Gets or sets a value specifying whether or not to highlight the start point of a sparkline. + + true, to highlight the start point; otherwise, false. + + + + Gets or sets the color to draw a sparkline point that has the highest value among all data points. + + A that defines the color to draw a data point with the maximum value. + + + + Gets or sets the color to draw a sparkline point that has the lowest value among all data points. + + A that defines the color to draw a data point with the minimum value. + + + + Gets or sets the color to draw sparkline points that have negative values (less than 0). + + A that defines the color to draw data points with negative values. + + + + Occurs when any property of the object has changed its value. + + + + + Gets or sets the color to draw the start point of a sparkline. + + A that defines the color to draw the start point. + + + + Returns a human-readable string that represents the object. + + A value that represents the object. + + + + Gets the type of the sparkline view. + + A enumeration value specifying the view type. + + + + Invokes the Visit method of the specified visitor for the current object. + + An object implementing the interface. + + + + Lists the values used to specify the available view types of a sparkline. + + + + + Sparkline data points are represented as area. + + + + + Sparkline data points are represented as bars. + + + + + Sparkline data points are represented as a line. + + + + + Sparkline data points are represented as win and loss squares. + + + + + The WinLoss sparkline view. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the type of the sparkline view. + + Always SparklineViewType.WinLoss. + + + + Invokes the Visit method of the specified visitor for the current object. + + An object implementing the interface. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.dll new file mode 100644 index 0000000..921d6c4 Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.xml new file mode 100644 index 0000000..4d56a7a --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.Utils.v23.2.xml @@ -0,0 +1,19210 @@ + + + + DevExpress.Utils.v23.2 + + + + + Contains classes that supply accessibility information for DevExpress UI elements. + + + + + The class that exposes the static QueryAccessibleInfo event used to supply accessibility information for DevExpress UI elements dynamically. + + + + + Allows you to supply accessibility information to DevExpress UI elements dynamically. + + + + + Contains data for the event. + + + + + Gets the System.Windows.Forms.AccessibleObject that allows you to return the standard accessibility information about the currently processed UI element. + + The accessibility object. + + + + Gets or sets a string that describes the UI element’s default action. + + The string that describes the UI element’s default action. + + + + Gets or sets a string that describes the visual appearance of the currently processed UI element. + + The string that describes the object’s visual appearance. + + + + Returns a BaseAccessible object (or its descendant) that stores additional accessibility information about the currently processed UI element. + + The BaseAccessible class descendant. + The object that stores additional accessibility information about the currently processed UI element. + + + + Gets or sets the name of the Accessible Object associated with a UI element. + + The name of the Accessible Object associated with a UI element. + + + + Gets the QueryAccessibleInfoEventArgs.Owner control’s child object that contains the currently processed UI element. + + The control’s child object that contains the currently processed UI element. + + + + Gets the control that contains the currently processed UI element. + + The control that contains the currently processed UI element. + + + + Gets or sets the accessible role of the currently processed UI element. + + The accessible role of the currently processed UI element. + + + + Returns a string representing the current object. + + A String value that represents the current object. + + + + Contains classes that provide basic functionality to documents published using the control. + + + + + Contains classes that provide basic functionality to the control. + + + + + The base for classes that provide the Print Preview functionality in Windows Forms applications. + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies whether or not the auto-zoom mode is enabled for the print preview. + + true if the auto-zoom mode is enabled; otherwise, false. + + + + Specifies the background color of a . + + A structure, specifying the background color of the Document Viewer. + + + + This property is overridden and never used. To customize the ‘s background image, use custom skins. + + + + + Hides the event of the base class. + + + + + This property is overridden and never used. To customize the ‘s background image and its layout, use custom skins. + + + + + Hides the event of the base class. + + + + + Specifies the border style of the . + + One of the enumeration values, representing the border style. + + + + For internal use. + + + + + For internal use. + + + + + Specifies the document assigned to the . + + An object implementing the interface. (Typically, this is a object.) + + + + Occurs when a receives a document change notification. + + + + + For internal use. + + + + + Specifies whether or not the current document is empty. + + true if the document is empty; otherwise false. + + + + Specifies whether to enable smooth scrolling in the Document Viewer control. + + True, to enable smooth scrolling in the Document Viewer control; otherwise, False. The Default value is equivalent to False. + + + + Specifies the foreground color of the . + + A structure, specifying the foreground color of the Document Viewer. + + + + For internal use. + + + + + Gets or sets a value indicating whether or not to use the metric system for measurements in the print preview. + + true, to use the metric system for measurements made in the document’s preview; otherwise, false. The default value is set to the System.Globalization.RegionInfo.CurrentRegion.IsMetric property value. + + + + For internal use. + + + + + Gets the maximum number of columns for multi-page reports displayed within the . + + An integer value, specifying the maximum number of columns in a multi-page report. + + + + Gets the maximum number of rows for a multi-page report displayed within the . + + An integer value, specifying the maximum number of rows in a multi-page report. + + + + Gets the maximum zoom factor of a report page within the . + + A value, specifying the maximum zoom factor of a report page within the Document Viewer. + + + + Gets the minimum zoom factor of a report page within the . + + A value, specifying the minimum zoom factor of a report page within the Document Viewer. + + + + Specifies the color used to draw borders around all pages in the . + + A structure that specifies the color of page borders. + + + + Specifies whether or not borders should be painted around all and selected document pages in the . + + A enumeration value, that specifies the visibility of page borders. + + + + Specifies the width of the borders around all pages in the . + + An integer value, specifying the width of the page borders. + + + + For internal use. + + + + + Sets the DocumentViewerBase.BackColor property to . + + + + + Sets the DocumentViewerBase.ForeColor property to . + + + + + Scrolls one page down. + + + + + Scrolls one page up. + + + + + Obtains the currently selected report page. + + An object implementing the interface, corresponding to the currently selected report page. (Typically, this is a object.) + + + + Specifies the color of borders around the currently selected page in the . + + A structure, specifying the border color of the selected page. + + + + Specifies the width of the borders around the currently selected page in the . + + An integer value, specifying the width of the selected page’s borders. + + + + Occurs when the selected page within the print preview is changed. + + + + + Specifies the index of a currently selected page in the . + + An integer value, specifying the index of the currently selected page. + + + + Moves selection to the first page of a document in the . + + + + + Moves selection to the last page of a document in the . + + + + + Moves selection to the next page of a document in the . + + + + + Moves selection to the previous page of a document in the . + + + + + Sets the cursor kind to be used within the . + + A object, specifying the cursor kind. + + + + Sets the input focus to the current instance of . + + + + + Determines the number of columns and rows used to display pages of a multipage report within a Print Preview. + + A enumeration value. + + + + Determines the number of columns and rows used to display pages of a multipage report within a Print Preview. + + The number of columns. It will not exceed the DocumentViewerBase.MaxPageColumns property value. + The number of rows. It will not exceed the DocumentViewerBase.MaxPageRows property value. + + + + Shows the specified page in the Document Viewer. + + An object implementing the interface. (Typically, this is a object.) + + + + Specifies whether or not the shows page margin lines. + + true to show page margin lines; otherwise false. + + + + Specifies whether or not to display hints in the . + + true to display hints; otherwise false. + + + + Specifies whether or not the current document is empty or null. + + A value. + + + + Specifies the background color of all tooltips in the . + + A structure, specifying the background color of the tooltips. + + + + Specifies the font of all tooltips in the . + + A structure, specifying the text settings that include the font face, size, and style attributes. + + + + Specifies the foreground color of all tooltips in the . + + A structure, specifying the foreground color of the tooltips. + + + + For internal use. Redraws the current page view in the . + + + + + Redraws the control’s scroll bars. + + + + + Specifies whether the Document Viewer control uses the DirectX Hardware Acceleration. + + True, to enable the DirectX Hardware Acceleration for the Document Viewer control; otherwise, False. The Default value is equivalent to False. + + + + For internal use. + + An integer value. + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + An integer value. + + + + Allows you to show the currently displayed page in full. + + + + + Specifies the current zoom factor of a document page in the . + + A value, specifying the current zoom factor of a document page. + + + + Occurs after the document current zoom factor has changed. + + + + + Zooms in on the page currently displayed in the . + + + + + Zooms out the page currently displayed in the . + + + + + Lists the values used to specify the visibility of page borders. + + + + + Both standard borders and selection borders are painted around pages. + + + + + Only standard page borders are painted. + + + + + Borders are not painted around pages at all. + + + + + Contains classes that provide a common look and feel management for DevExpress controls. + + + + + Enumerates values for the UserLookAndFeel.ActiveStyle property. + + + + + Control borders are flat. The following screenshot shows the Flat style applied to a button edit control. + + + + + + Borders and buttons have an Office 2003 style. The borders and client area are highlighted when the mouse pointer is positioned over them or they are focused. + The following screenshot shows the Office2003 style applied to a button edit control. + + + + + + + Control elements are painted using the skin determined by the UserLookAndFeel.SkinName property. The following screenshot shows a button editor painted using the default Caramel skin. + + + + + + Control borders are three-dimensional. The following screenshot shows the Style3D style applied to a button edit control. + + + + + + Borders have an Office XP style. Borders and the client area are highlighted when the mouse pointer is positioned over them or they are focused. + The following screenshot shows the UltraFlat style applied to a button edit control. + + + + + + + Control elements are painted using the XP theme. The following screenshot shows the WindowsXP style applied to a button edit control. + + + + + + Provides centralized access to global look-and-feel settings that affect all DevExpress controls in your application. + + + + + Creates an instance of the object. + + + + + Initializes a new instance of the class with the specified container. + + A that represents the container for the Default LookAndFeel object. + + + + Registers the Bonus Skins for runtime use. + + true to register the Bonus Skins. + + + + Gets the object defining Default LookAndFeel settings. + + A object defining Default LookAndFeel settings. + + + + Contains classes that support the look-and-feel mechanism for DevExpress controls and components. + + + + + Contains settings that specify the look and feel of an XtraUserControl and all DevExpress controls placed on it. + + + + + Initializes a new instance of the class with the specified owner. + + The owner of the created object. + + + + Copies properties of the specified object to the current object. + + The source object. + + + + Disposes of the current object. + + + + + For internal use. + + + + + Gets the actual touch UI scale factor for the current container. + + The actual touch UI scale factor for the current container. + + + + Gets the actual availability of touch UI mode for the current container. + + A Boolean value that specifies the actual availability of touch UI mode for the current container. + + + + Reverts the look and feel settings to their default values. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the scale factor used to calculate the size and distance between specific control elements when touch UI mode is enabled. + + The scale factor used to calculate the size and distance between specific control elements when touch UI mode is enabled. + + + + Gets or sets whether the current container and its child controls use touch UI mode, in which the controls automatically increase their size and the distance between some of their elements. + + A value that specifies if touch UI mode is enabled for the current container and its child controls. + + + + Contains settings that specify the look and feel of the current form and all DevExpress controls placed on the form. + + + + + Initializes a new instance of the class with the specified settings. + + A Form that owns the newly created object. + + + + Enumerates values for the UserLookAndFeel.Style property. + + + + + Control borders are flat. It is not recommended that you use this style (see this announcement for more details: WinForms Deprecation Notice — Classic Visual Styles). + + + + + Borders and buttons have an Office 2003 style. The borders and client area are highlighted when the mouse pointer is positioned over them or they are focused. It is not recommended that you use this style (see this announcement for more details: WinForms Deprecation Notice — Classic Visual Styles). + + + + + Control elements are painted using the skin specified by the UserLookAndFeel.SkinName property. + + + + + Control borders are three-dimensional. It is not recommended that you use this style (see this announcement for more details: WinForms Deprecation Notice — Classic Visual Styles). + + + + + Borders have an Office XP style. Borders and the client area are highlighted when the mouse pointer is positioned over them or they are focused. It is not recommended that you use this style (see this announcement for more details: WinForms Deprecation Notice — Classic Visual Styles). + + + + + Contains values used to set the WindowsFormsSettings.TouchUIMode property. + + + + + The same as False. + + + + + Touch UI mode is disabled. + + + + + Touch UI mode is enabled. + + + + + Represents look and feel settings for controls provided by DevExpress. + + + + + Initializes a new instance of the class. + + An object which represents the control that will own the created object. This value is assigned to the UserLookAndFeel.OwnerControl property. + + + + Gets the actual object currently applied. + + A object currently applied. + + + + Gets the name of the currently applied skin. + + A string which specifies the name of the currently applied skin. + + + + Gets the style currently applied. + + + + + Returns the name of the currently applied swatch. + + A String value that is the swatch name. + + + + This method supports internal infrastructure and is not intended for use in code. + + + + + + Returns whether the application is currently in Compact UI Mode. The return value depends on both the WindowsFormsSettings.CompactUIMode property and the currently applied skin (for instance, the WXI Compact skin forces the Compact UI Mode). + + true if the application is currently in Compact UI Mode; false if the Regular mode is currently active. + + + + Gets the Default LookAndFeel object to use for controls when the UserLookAndFeel.UseDefaultLookAndFeel property is set to true. + + The Default LookAndFeel object. + + + + Gets the name of the default skin style. + + + + + Releases all resources used by the current object. + + + + + This method is not intended to be used in code. Use the WindowsFormsSettings.CompactUIMode property instead to switch between regular and compact UI modes. + + Specifies whether the Compact UI Mode is enabled. + true if switching between regular and compact UI modes should raise the style changed event; false to silently switch between UI modes. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + Gets the actual value of the UserLookAndFeel.SkinMaskColor setting for the current object. + + The actual value of the UserLookAndFeel.SkinMaskColor setting for the current object. + + + + Gets the actual value of the UserLookAndFeel.SkinMaskColor2 setting for the current object. + + The actual value of the UserLookAndFeel.SkinMaskColor2 setting for the current object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. Use the WindowsFormsSettings.TouchScaleFactor property instead. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. Use the WindowsFormsSettings.TouchUIMode property instead. + + + + + Gets whether the UserLookAndFeel.SkinMaskColor or UserLookAndFeel.SkinMaskColor2 property is specified for the current object. + + true if the UserLookAndFeel.SkinMaskColor or UserLookAndFeel.SkinMaskColor2 setting is specified; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the control that owns the current object. + + An object which represents the control that owns the current object. + + + + Gets the painter based on the style currently applied for drawing control’s elements. + + A BaseLookAndFeelPainters class descendant specifying the painter corresponding to the current style which is defined by UserLookAndFeel.ActiveStyle. + + + + Gets or sets the parent LookAndFeel. + + A object specifying the parent LookAndFeel; null if the parent LookAndFeel is not assigned. + + + + Reverts the look and feel settings to their default values. + + + + + Sets the UserLookAndFeel.ParentLookAndFeel property to its default value. + + + + + Applies the default look and feel settings to a control. + + + + + Applies the Flat style to a control. + + + + + Applies the Office2003 style to a control. + + + + + Applies the desired DevExpress skin to the application. + + A static field of the DevExpress.LookAndFeel.SkinStyle class that specifies the skin name. + + + + Applies the specified skin and palette. + + A SkinSvgPalette object specifying the skin and palette to apply. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A string. + A TouchUIMode value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A string. + A Boolean value. + + + + Applies the specified skin and palette. + + A string value specifying the name of the skin to apply. + The name of the palette used to color vector images to apply. + + + + Applies the specified skin. + + A string value specifying the skin name to apply. + + + + For internal use. + + + + + This method supports internal infrastructure and is not intended to be used in code. + + + + + + + Sets the look and feel settings of the current object to the specified values. + + A value which specifies the style of the current object. This value is assigned to the UserLookAndFeel.Style property. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true, to use the look and feel settings provided by the parent object or default look and feel object; false, to apply the current object’s settings. This value is assigned to the UserLookAndFeel.UseDefaultLookAndFeel property. + A string value specifying the skin name. This value is assigned to the UserLookAndFeel.SkinName property. + A value that specifies whether touch-aware mode needs to be enabled or disabled. This value is assigned to the property. + The scale factor applied when touch-aware mode is enabled. This value is assigned to the WindowsFormsSettings.TouchScaleFactor property. + + + + Sets the look and feel settings of the current object to the specified values. + + A value which specifies the style of the current object. This value is assigned to the UserLookAndFeel.Style property. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true, to use the look and feel settings provided by the parent object or default look and feel object; false, to apply the current object’s settings. This value is assigned to the UserLookAndFeel.UseDefaultLookAndFeel property. + A string value specifying the skin name. This value is assigned to the UserLookAndFeel.SkinName property. + A value that specifies whether touch-aware mode needs to be enabled or disabled. This value is assigned to the property. + + + + Sets the look and feel settings of the current object to the specified values. + + A enumeration value which specifies the style of the current object. This value is assigned to the UserLookAndFeel.Style property. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true to use the look and feel settings provided by the parent object or default look and feel object; false to apply the current object’s settings. This value is assigned to the UserLookAndFeel.UseDefaultLookAndFeel property. + A string value specifying the skin name. This value is assigned to the UserLookAndFeel.SkinName property. + true, to enable the touch-aware mode; otherwise, false. This value is assigned to the property. + The scale factor applied when touch-aware mode is enabled. This value is assigned to the WindowsFormsSettings.TouchScaleFactor property. + + + + Sets the look and feel settings of the current object to the specified values. + + A enumeration value which specifies the style of the current object. This value is assigned to the UserLookAndFeel.Style property. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true to use the look and feel settings provided by the parent object or default look and feel object; false to apply the current object’s settings. This value is assigned to the UserLookAndFeel.UseDefaultLookAndFeel property. + A string value specifying the skin name. This value is assigned to the UserLookAndFeel.SkinName property. + true, to enable the touch-aware mode; otherwise, false. This value is assigned to the property. + + + + Sets the look and feel settings of the current object to the specified values. + + A enumeration value which specifies the style of the current object. This value is assigned to the UserLookAndFeel.Style property. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true to use the look and feel settings provided by the parent object or default look and feel object; false to apply the current object’s settings. This value is assigned to the UserLookAndFeel.UseDefaultLookAndFeel property. + A string value specifying the skin name. This value is assigned to the UserLookAndFeel.SkinName property. + A string value specifying the name of the palette used to color vector images. + + + + Sets the look and feel settings of the current object to the specified values. + + A enumeration value which specifies the style of the current object. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true to use the look and feel settings provided by the parent object or default look and feel object; false to apply the current object’s settings. + A string value specifying the skin name. + + + + Sets the look and feel settings of the current object. + + A enumeration value which specifies the style of the current object. + true if a control should be painted using the WindowsXP theme; otherwise, false. + true to use the look and feel settings provided by the parent object or default look and feel object; false to apply the current object’s settings. + + + + Applies the Style3D style to a control. + + + + + Applies the UltraFlat style to a control. + + + + + Applies the WindowsXP style to a control. + + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Gets or sets a custom hue applied to some skin elements. + + A custom hue applied to skin elements. + + + + Gets or sets the second custom hue, typically applied to some skin elements when they are highlighted/hovered. + + The second custom hue applied to some skin elements. + + + + Gets or sets the name of a skin style. + + A string value specifying the skin style’s name. + + + + Gets or sets the style of the current object. + + The style of the current object. + + + + Occurs on changing properties of the current object or the parent LookAndFeel specified by the UserLookAndFeel.ParentLookAndFeel member. + + + + + Returns the text representation of the current object. + + The text representation of the current object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A UserLookAndFeel value. + + + + Notifies controls that look-and-feel settings have been changed and the controls need to be refreshed. + + + + + Gets or sets whether the current object’s settings are in effect. + + true to use look and feel settings provided by the parent object or default look and feel object; false to enable this object’s settings. + + + + Gets or sets whether borders of controls are painted in the same manner as borders of standard text editors built into Microsoft Windows 7. This property is in effect if the current OS is Windows 7 and the DevExpress XP paint theme is applied. + + true if borders of controls are painted in the same manner as borders of standard text editors; otherwise, false. + + + + Gets or sets whether controls should be painted using the native Windows theme. + + true if controls should be painted using the native Windows theme; otherwise, false. + + + + Contains classes for skin management. + + + + + Manages skins for DevExpress controls. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether dragging-and-dropping columns/fields is indicated using arrow indicators. + + true if dragging-and-dropping columns is indicated using arrow indicators; otherwise, false. + + + + Gets whether the form title bar skinning feature is enabled. + + true if the form title bar skinning feature is enabled; otherwise, false. + + + + Gets or sets whether the window ghosting feature is enabled for skinned XtraForm objects. + + A Boolean value that specifies whether the window ghosting feature is enabled. The default value is false. + + + + Provides access to the default skin manager. + + A object that represents the default skin manager. + + + + Gets the name of the default skin, which is used by controls by default. + + + + + Disables the title bar skinning feature for DevExpress forms and message boxes. + + + + + Disables the title bar skinning feature for MDI child DevExpress forms. + + + + + Enables the title bar skinning feature for DevExpress forms and message boxes. + + + + + Enables the title bar skinning feature for DevExpress forms and message boxes, if the application is running under Microsoft Windows XP. + + + + + Enables the title bar skinning feature for MDI child DevExpress forms. + + + + + Returns a list of the currently available skins. + + A list of the currently available skins. + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Returns a skin element with the specified name of a control in the specified product displayed using the specified skin provider. + + A DevExpress.Skins.SkinProductId enumeration value that specifies the product in which the required element is contained. + An object implementing the DevExpress.Skins.ISkinProvider interface that is used for painting controls. + A String value that specifies the name of the required element. + A DevExpress.Skins.SkinElement object that represents a skin element of a control. + + + + This method returns the specified skin name, if it’s valid. If the skin name is invalid, the default skin’s name is returned. + + A string that specifies the skin name to test. + A string that specifies the valid skin name. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Registers the specified assembly that contains custom skins. Registered skins cannot be applied to splash screens; use the WindowsFormsSettings.RegisterUserSkins(Assembly) method instead. + + An assembly that should be registered. + true if the assembly is successfully registered; otherwise, false. + + + + Registers the specified skin stored as a BLOB for runtime use. The registered skin cannot be applied to splash screens; use the WindowsFormsSettings.RegisterUserSkin(SkinBlobXmlCreator) method instead. + + An object that contains information on the target BLOB skin. + + + + Registers the specified assembly that contains custom skins. + + An assembly that should be registered. + true, if the assembly is successfully registered; othrewise, false. + + + + Loads a skin patch from the stream. Patches loaded by this method overload are not applied to Splash Screens, use other overloads instead. + + The stream to load a patch from. + true to register palettes from the patch, false to leave palettes of the default skin. + + + + Loads a skin patch embedded as a resource in a custom assembly. + + The custom assembly that stores a patch to load. + The assembly resource path. + true to register palettes from the patch, false to leave palettes of the default skin. + + + + Loads a skin patch from the local storage file. + + The path to a file that stores a patch. + true to register palettes from the patch, false to leave palettes of the default skin. + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Call this method to undo all patches applied to the target skin. + + A skin whose patches should be discarded. + + + + Gets the collection of skins that are currently available for use in DevExpress controls. + + A DevExpress.Skins.SkinContainerCollection collection that stores available skins. + + + + Contains utility classes used by DevExpress controls and components. + + + + + Contains controls supporting animation effects. + + + + + Represents parameters that specify a transition. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An integer value that specifies the time interval between frames in the transition. + An integer value that specifies the frame count in the transition. + + + + Assigns the specified parameter values to parameters not set in this object. + + An object that specifies transition parameters. + + + + Gets or sets the frame count in the transition. + + An integer value that specifies the frame count in the transition. + + + + Gets the time interval between frames in the transition. + + An integer value that specifies time interval between frames in the transition. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + A base class for transitions. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first frame in the transition. + An object that specifies the last frame in the transition. + An object that specifies the transition parameters. + + + + Gets whether the transition is in progress. + + true if the transition is in progress; otherwise, false. + + + + Fires when the transition completes. + + + + + Disposes unmanaged resources. + + + + + Gets the first frame in the transition. + + An object that specifies the first frame in the transition. + + + + Fires after a frame is displayed. + + + + + Provides access to transition parameters such as the frame count, time interval between frames, etc. + + An object that specifies transition parameters. + + + + Runs the transition between the specified frames with the specified parameters. + + An object that specifies the first frame in the transition. + An object that specifies the last frame in the transition. + An object that specifies transition parameters. + + + + Starts the transition. + + + + + Stops the transition. + + + + + Gets the last frame in the transition. + + An object that specifies the last frame in the transition. + + + + Provides access to parameters that specify the transition that changes one screen to another with the clock effect. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the transition goes clockwise or counterclockwise. + + A value that specifies the transition direction. + + + + Enumerates values that specify the transition direction. + + + + + The transition goes clockwise. + + + + + The transition goes counterclockwise. + + + + + The transition goes in both directions: clockwise and counterclockwise. + + + + + Represents a transition from one screen to another with the clock effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that specifies transition parameters. + + + + Provides access to transition properties. + + An object that contains transition properties. + + + + Provides access to parameters that specify the transition that changes one screen to another with the comb effect. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the transition goes towards the inside coming in from the outside. + + true if the transition goes towards the inside coming in from the outside; otherwise, false. + + + + Gets or sets the number of stripes in the transition. + + An integer value that specifies the number of stripes in the transition. + + + + Gets or sets whether the transition goes vertically. + + true if the transition goes vertically; otherwise, false + + + + Represents a transition from one screen to another with the comb effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that specifies transition parameters. + + + + Provides access to parameters that specify the transition. + + An object that contains transition parameters. + + + + Enumerates values that specify the cover effect. + + + + + The animation goes from the bottom edge to the top edge. + + + + + The animation goes from the bottom-left corner to the top-right corner. + + + + + The animation goes from the bottom-right corner to the top-left corner. + + + + + The animation goes from the left edge to the right edge. + + + + + The animation goes from the right edge to the left edge. + + + + + The animation goes from the top edge to the bottom edge. + + + + + The animation goes from the top-left corner to the bottom-right corner. + + + + + The animation goes from the top-right corner to the bottom-left corner. + + + + + Represents a transition from one screen to another with the cover effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that contains cover transition parameters. + + + + Provides access to parameters that specify the cover transition. + + An object that specifies cover transition parameters. + + + + Represents a transition from one screen to another with the dissolve effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that contains transition parameters. + + + + Represents a transition from one screen to another with the fade effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that specifies animation parameters. + + + + Contains parameters applied to the associated animation. + + + + + Assigns the specified object’s values to the corresponding values that are not set in this object. + + An object that specifies transition parameters. + + + + Gets or sets the frame count in the transition. + + An integer value that specifies the frame count in the transition. + + + + Gets or sets the time interval between frames in the associated transition. + + An integer value that specifies time interval between frames in the associated transition. + + + + Provides access to parameters that specify the transition that changes one screen to another with the clock effect. + + + + + Gets or sets whether the transition goes clockwise or counterclockwise + + A enumeration value that specifies the transition direction. + + + + Provides access to parameters that specify the transition that changes one screen to another with the comb effect. + + + + + Gets or sets whether the animation goes towards the inside coming in from the outside. + + true if the animation goes towards the inside coming in from the outside; otherwise, false. + + + + Gets or sets the number of stripes in the transition. + + An integer value that specifies the number of stripes in the transition. + + + + Gets or sets whether the transition goes vertically. + + true if the transition goes vertically; otherwise, false. + + + + Provides access to parameters that specify the transition that changes one screen to another with the push effect. + + + + + Gets or sets the animation direction. + + A value that specifies the animation direction. + + + + Provides access to parameters that specify the transition that changes one screen to another with the shape effect. + + + + + Gets or sets the transition direction and shape. + + A value that specifies the transition direction and shape. + + + + Provides access to parameters that specify the transition that changes one screen to another with the slide and fade effects. + + + + + Gets or sets the background visible during the transition. + + A value that specifies the background visible during the transition. + + + + Provides access to parameters that specify the transition that changes one screen to another with the push effect. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the transition direction. + + A value that specifies the transition direction. + + + + Enumerates values that specify the transition direction. + + + + + The transition goes from the bottom edge. + + + + + The transition goes from the left edge. + + + + + The transition goes from the right edge. + + + + + The transition goes from the top edge. + + + + + Represents a transition from one screen to another with the push and fade effects. + + + + + Initializes a new instance of the class. + + + + + Represents a transition from one screen to another with the push effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that specifies animation parameters. + + + + Provides access to transition parameters. + + An object that specifies transition parameters. + + + + Represents a transition from one screen to another with the segmented fade effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that specifies animation parameters. + + + + Provides access to parameters that specify the transition that changes one screen to another with the shape effect. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the transition direction and shape. + + A value that specifies the transition direction and shape. + + + + Enumerates values that specify the transition direction and shape. + + + + + The transition goes inside-out as a circle. + + + + + The transition goes outside-in as a circle. + + + + + The transition goes inside-out as a rectangle. + + + + + The transition goes outside-in as a rectangle. + + + + + Represents a transition from one screen to another with the shape effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that contains transition parameters. + + + + Provides access to transition parameters. + + An object that specifies transition parameters. + + + + Provides access to parameters that specify the transition that changes one screen to another with the slide and fade effects. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the background visible during the transition. + + A value that specifies the background visible during the transition. + + + + Represents a transition from one screen to another with the slide and fade effects. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Provides access to transition parameters. + + An object that specifies transition parameters. + + + + Represents a transition from one screen to another with the slide effect. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the first image in the transition. + An object that specifies the last image in the transition. + An object that contains transition parameters. + + + + An object that animates the target control. + + + + + Initializes a new Transition instance with the default settings. + + + + + Provides access to Bar indicator settings. This indicator is active when the WaitingAnimatorType is set to “Bar”. + + An object that stores Bar waiting indicator settings. + + + + Gets or sets the control whose navigation is animated by this Transition object. + + The control whose navigation is animated by this Transition object. + + + + Gets or sets the mathematical algorithm that specifies the speed and acceleration mode for the Transition animation effects. + + An EasingMode enumerator value that specifies the speed and acceleration mode for the Transition animation effects. + + + + Provides access to Bar indicator settings. This indicator is active when the WaitingAnimatorType is set to “Line”. + + An object that stores Line waiting indicator settings. + + + + Provides access to Bar indicator settings. This indicator is active when the WaitingAnimatorType is set to “Ring”. + + An object that stores Ring waiting indicator settings. + + + + Gets or sets whether this Transition should display a waiting indicator until its animation starts. Use the WaitingAnimatorType property to specify the waiting indicator type. + + A DefaultBoolean enumerator value that specifies whether this Transition should display a waiting indicator. + + + + Gets or sets the type of animation effect applied by this Transition. This property accepts “…Transition” objects from the namespace. + + An object that specifies the animation effect applied by this Transition. + + + + Gets or sets the Wait Indicator type - bar, ring, or line. Wait Indicators are visible when the ShowWaitingIndicator property is enabled. + + The Wait Indicator type. + + + + Provides access to common Wait Indicator settings. Wait Indicators are visible when the ShowWaitingIndicator property is enabled. + + An object that stores common Wait Indicator settings. + + + + Allows you to implement animated transitions between control states. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A container for the being created. + + + + Serves as a notification event that an animated transition between a control’s states is complete. + + + + + Allows you to perform custom actions before a transition between control states starts, or allows you to cancel the transition. + + + + + Allows you to customize an animated state transition. + + + + + Finalizes the current animated state transition. + + + + + Gets or sets the number of animation frames. + + The number of animation frames. + + + + Gets or sets the time between animation frames, in special units. + + The time between animation frames. + + + + Returns the type of the transition associated with the spceified control and converted to the specified type. + + A control for which to return the associated transition type. + The type to which to convert to the associated transition type. + The transition type associated with the spceified control. + + + + Gets whether the is being disposed of. + + true if the is being disposed of; otherwise, false. + + + + Gets whether an animated transition between the start and end control states is in progress. + + true if the animated transition between the states is in progress; otherwise, false. + + + + Gets or sets whether the wait/load indicator is displayed during animation. + + true if the wait/load indicator is displayed during the animation; otherwise, false. + + + + Starts an animated state transition for the specified control. + + The control for which to start the animated state transition. + + + + Shows the wait indicator over the specified control using the specified properties. + + A Control over which to show the wait indicator. + A IWaitingIndicatorProperties object that comprises the wait indicator properties. + + + + Shows the wait indicator of the specified type over the specified control. + + A Control over which to show the wait indicator. + A WaitingAnimatorType enumeration value that specifies the type of indicator to show. + + + + Hides the wait indicator. + + + + + Provides access to the collection of control state transitions. + + The collection of control state transitions. + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for this Transition Manager. + + A DefaultBoolean enumerator value that specifies whether or not this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + A DirectX-based transition that animates navigation between application layers. + + + + + Initializes a new ZoomTransition instance with the default settings. + + + + + Gets or sets an object that stores core ZoomTransition settings: the animation direction (“in” or “out”), initial and final animation bounds. + + An object that stores core ZoomTransition settings. + + + + Enumerates values that specify the transition direction. + + + + + The transition goes with the zoom-in effect. + + + + + The transition goes with the zoom-out effect. + + + + + Stores core settings: animation bounds and direction. + + + + + Initializes a new ZoomTransitionSettings instance with the default settings. + + + + + Specifies whether a that owns this object should play the “zoom in” or “zoom out” animation. + + A ZoomTransitionDirection enumeration value that specifies the animation direction. + + + + Gets or sets initial bounds from which the ZoomTransition animation should zoom in or out to ZoomTransitionSettings.TargetBounds. + + A Rectangle that specifies initial animation bounds. + + + + Gets or sets the final bounds to which the ZoomTransition animation should arrive from its initial ZoomTransitionSettings.SourceBounds. + + A Rectangle that specifies the final ZoomTransition animation bounds. + + + + Represents an appearance object. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with default settings. + + A DevExpress.Utils.AppearanceDefault object containing the default appearance settings. + + + + Initializes a new instance of the class with the specified settings. + + An object whose settings are used to initialize the created object’s properties. + A DevExpress.Utils.AppearanceDefault object. + + + + Initializes a new instance of the class. + + An representing the appearance object whose settings are used to initialize the created object’s properties. + A DefaultAppearance object representing default appearance settings. + + + + Initializes a new instance of the class with the specified name and parent. + + An object which represents the parent of the created object. This value is assigned to the AppearanceObject.ParentAppearance property. + A value specifying the name of the created object. This value is assigned to the AppearanceObject.Name property. + + + + Initializes a new instance of the class with the specified parent. + + An object representing the parent appearance object. This value is assigned to the AppearanceObject.ParentAppearance property. + + + + Initializes a new instance of the class with the specified owner, parent and name. + + An object implementing the IAppearanceOwner interface. + An object which represents the parent of the created object. This value is assigned to the AppearanceObject.ParentAppearance property. + A value specifying the name of the created object. This value is assigned to the AppearanceObject.Name property. + + + + Initializes a new instance of the class with the specified owner and parent appearance object. + + An object implementing the IAppearanceOwner interface. + An object which represents the parent appearance object. This value is assigned to the AppearanceObject.ParentAppearance property. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Initializes a new instance of the class with the specified name. + + A value specifying the name of the created object. This value is assigned to the AppearanceObject.Name property. + + + + Sets the appearance object’s settings to default values. + + An AppearanceDefault object containing default appearance settings. + + + + Copies all settings from the appearance object passed as a parameter. + + An object representing the source of the operation. + + + + Copies all the settings in the appearance object passed as the parameter to the current object without raising the AppearanceObject.Changed event. + + An object representing the source of the operation. + + + + Gets or sets the background color if the AppearanceObject.BackColor2 property’s value is Color.Empty. Otherwise, it specifies the gradient’s starting color. + + A object specifying the background color. + + + + Gets or sets the end color of the background’s gradient brush. + + A object specifying the end color of the linear gradient brush used to fill the background. + + + + Locks the object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. + + + + + Gets or sets the border color. + + A object specifying the border color. + + + + Calculates the size of a string painted with the default font. + + A System.Drawing.Size structure which represents the size (in pixels) of a string. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Calculates the size of a string painted with the font specified by the current object. + + A object which provides painting facilities. + A structure which represents the size (in pixels) of a string. + + + + Calculates the string size. + + A object which provides storage for pens, fonts and brushes. + A StringFormatInfo object that stores line spacing, alignment and other formatting setting for the string. + A String value that is the string, whose size is to be obtained. + An Int32 value that is the maximum allowed string width. + An Int32 value that is the maximum allowed string height. + A Boolean value that specifies whether or not the string is trimmed. + A Size structure that is the string size. + + + + Calculates the string size. + + A object which provides storage for pens, fonts and brushes. + A StringFormatInfo object that stores line spacing, alignment and other formatting setting for the string. + A String value that is the string, whose size is to be obtained. + An Int32 value that is the maximum allowed string width. + An Int32 value that is the maximum allowed string height. + A Size structure that is the string size. + + + + Calculates the string size. + + A object which provides storage for pens, fonts and brushes. + A StringFormatInfo object that stores line spacing, alignment and other formatting setting for the string. + A String value that is the string, whose size is to be obtained. + An Int32 value that is the maximum allowed string width. + A Size structure that is the string size. + + + + Calculates the string size. + + A object which provides storage for pens, fonts and brushes. + A StringFormat object that stores line spacing, alignment and other formatting setting for the string. + A String value that is the string, whose size is to be obtained. + An Int32 value that is the maximum allowed string width. + An Int32 value that is the maximum allowed string height. + A Boolean value that specifies whether or not the string is trimmed. + A Size structure that is the string size. + + + + Calculates the string size. + + A object which provides storage for pens, fonts and brushes. + A StringFormat object that stores line spacing, alignment and other formatting setting for the string. + A String value that is the string, whose size is to be obtained. + An Int32 value that is the maximum allowed string width. + An Int32 value that is the maximum allowed string height. + A Size structure that is the string size. + + + + Calculates the size of the specified string drawn with the specified object. + + A object which provides storage for pens, fonts and brushes. + A object which represents formatting information, such as line spacing and alignment, for the string. + A value which represents a string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure which represents the size, in pixels, of the string. + + + + Calculates the size of the specified string. + + A object which provides storage for pens, fonts and brushes. + The string to be measured. + An integer value specifying the maximum width of the string (in pixels). + The measured size of the string, in pixels. + + + + Calculates the size of the specified string drawn with the specified object. + + A object which provides painting facilities. + A StringFormatInfo object which represents formatting information, such as the line spacing for the string. + A value which represents the string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string when it’s drawn with the specified font, fitting the string into a clipping rectangle. Allows you to determine whether the string does not fit the clipping rectangle. + + A System.Drawing.Graphics object which provides painting facilities. + Contains formatting information, such as the line spacing and alignment of the string. + The string to be measured. + The maximum width of the clipping rectangle that will fit the string (in pixels). + The maximum height of the clipping rectangle that will fit the string (in pixels). + true if the text is trimmed (its size is larger than the clipping rectangle); otherwise, false. + The measured size of the string, in pixels. + + + + Calculates the size of the specified string drawn with the specified format, fitting the string into a clipping rectangle. + + A System.Drawing.Graphics object which provides painting facilities. + A object that contains formatting information, such as the line spacing and alignment of the string. + The string to be measured. + The maximum width of the clipping rectangle that will fit the string (in pixels). + The maximum height of the clipping rectangle that will fit the string (in pixels). + The measured size of the string, in pixels. + + + + Calculates the size of the specified string drawn with the specified object. + + A object which provides painting facilities. + A object which represents formatting information, such as the line spacing for the string. + A value which represents the string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string. + + A object which provides painting facilities. + The string to be measured. + An integer value specifying the maximum width of the string, in pixels. + The measured size of the string, in pixels. + + + + Calculates the length of the specified string drawn with the specified formatting. + + A object that provides storage for pens, fonts and brushes. + A StringFormatInfo object that contains formatting information, such as the line spacing and alignment of the string. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure that is the size of the string (in pixels). + + + + Calculates the length of the specified string drawn with the specified object. + + A object that provides storage for pens, fonts and brushes. + A object that contains formatting information, such as the line spacing and alignment of the string. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure that is the size of the string (in pixels). + + + + Calculates the length of the specified string. + + A object that provides storage for pens, fonts and brushes. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure that is the size of the string (in pixels). + + + + Calculates the length of the specified string drawn with the specified formatting. + + A object which provides painting facilities. + A StringFormatInfo object that contains formatting information, such as the line spacing and alignment of the string. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure that is the size of the string (in pixels). + + + + Calculates the length of the specified string drawn with the specified object. + + A object that provides painting facilities. + A object that contains formatting information, such as the line spacing and alignment of the string. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A structure that is the size of the string (in pixels). + + + + Calculates the length of the specified string. + + A object which provides painting facilities. + The string to measure. + An integer value specifying the maximum width of the string (in pixels). + A System.Drawing.Size structure that is the size of the string (in pixels). + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Fires when the appearance object’s properties are changed. + + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current appearance object. + + + + Copies the activated settings from the appearance object passed as the parameter. + + An object whose settings are going to be copied. + + + + Gets the default appearance settings which are used to paint 3-D elements in Windows. + + An object which represents the default appearance settings used to paint 3-D elements in Windows. + + + + Gets or sets the default font for controls. + + A object which is the default font for controls. The default value is the Tahoma font. + + + + Gets and sets the font used to display text on menus. + + A object which is the default font for menu items. If not set, the property value is specified by the System.Windows.Forms.SystemInformation.MenuFont property. + + + + Releases all resources used by the current appearance object. + + + + + Draws the background for the area contained within the specified boundary. + + A object providing storage for the pens, fonts and brushes used during painting. + A structure specifying the drawing area. + A Boolean value. + + + + Draws the background for the area contained within the specified boundary. + + A object providing storage for the pens, fonts and brushes used during painting. + A structure specifying the drawing area. + + + + Draws the background for the area contained within the specified boundary. + + A object that provides a means for painting. + A object providing storage for the pens, fonts and brushes used during painting. + A structure specifying the drawing area. + A Boolean value. + + + + Draws the background. + + A object that provides a means for painting. + A object providing storage for the pens, fonts and brushes used during painting. + A structure specifying the drawing area. + + + + Draws the specified text string in the specified rectangle using the specified formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A value representing the drawing area. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle using the specified formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A value representing the drawing area. + A object which specifies the color and texture of the drawn text. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified color and format. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the text to be drawn. + A value representing the drawing area. + A object which determines the color and texture of the drawn text. + A object which specifies formatting attributes, such as the line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified color. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the text to be drawn. + A value representing the drawing area. + A object which determines the color and texture of the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Color using the formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A structure which represents the drawing area. + A object which specifies the color and texture of the drawn text. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Color using the specified TextOptions. + + GraphicsCache object providing storage for the pens, fonts and brushes used during painting. + String to draw. + Rectangle structure that specifies the location of the drawn text. + Color of the drawn text. + Settings applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Color using the formatting attributes of the specified StringFormat. + + GraphicsCache object providing storage for the pens, fonts and brushes used during painting. + String to draw. + Rectangle structure that specifies the location of the drawn text. + Color of the drawn text. + StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Font using the specified formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A value representing the drawing area. + A object which defines the font and associated settings of the text to be drawn. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Font using the specified formatting attributes. + + A GraphicsCache object providing storage for the pens, fonts and brushes used during painting. + A String to draw. + A Rectangle structure that specifies the location of the drawn text. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified font, color and format. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A structure which represents the drawing area. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A object which specifies formatting attributes such as the line spacing and alignment that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Font using the specified formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A value representing the drawing area. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string at the specified location with the specified Color and Font objects using the formatting attributes of the specified StringFormat. + + GraphicsCache object providing storage for the pens, fonts and brushes used during painting. + String to draw. + Rectangle structure that specifies the location of the drawn text. + Font that defines the text format of the string. + Color of the drawn text. + StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified font and format. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the text to be drawn. + A value representing the drawing area. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies formatting attributes, such as the line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified format. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the text to be drawn. + A value representing the drawing area. + A object which specifies formatting attributes, such as the line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the text to be drawn. + A value representing the drawing area. + + + + Draws the specified text string in the specified rectangle with the specified Font using the formatting attributes. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A value representing the drawing area. + A StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + An integer value specifying the angle in degrees at which the text should be drawn. + + + + Draws a text string vertically with the specified angle and at the specified position using the specified font, color and format. + + A object which provides the storage for the pens, fonts and brushes used during painting. + A value which represents the text to be drawn. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A structure which represents the drawing area. + A object which specifies formatting attributes such as the line spacing and alignment that are applied to the drawn text. + An integer value specifying the angle in degrees at which the text should be drawn. + + + + Returns an empty appearance object. + + An object whose settings are not initialized. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Fills the interior of a rectangle specified by a structure. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the drawing area. + A Boolean value. + + + + Fills the interior of a rectangle specified by a structure. + + A object providing storage for the pens, fonts and brushes used during painting. + A value representing the drawing area. + + + + Gets or sets the font used to paint the text. + + A object specifying the font used to display the contents of elements. + + + + Gets the height of the font used by the appearance object. + + An integer value which specifies the font’s height. + + + + Gets or sets an integer value by which the font size is adjusted. + + An integer value by which the font size is adjusted. + + + + Gets or sets an additional style to be applied to the font. + + A System.Drawing.FontStyle enumeration value that specifies a style by which to modify the font. + + + + Gets or sets the foreground color. + + A structure specifying the foreground color. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the brush used to draw an element’s background. + + A object that provides access to the pens and brushes used for painting. + A structure specifying the rectangle for which a brush is created. + A descendant representing the brush specified by the appearance object’s settings. + + + + Gets the solid brush used to draw the element’s background. + + A object that provides access to the pens and brushes used for painting. + A descendant representing the brush specified by the appearance object’s settings. + + + + Gets the background color specified by the appearance object’s settings. + + A object representing the background color specified by the appearance object’s settings. + + + + Returns the BackColor (AppearanceObject.BackColor) for the target LookAndFeel object. + + An ISkinProvider that is a LookAndFeel object whose BackColor is to be returned. + A Color that is the BackColor for the target LookAndFeel object. + + + + Gets the ending color of the linear gradient brush, specified by the appearance object’s settings. + + A object representing the end color of the linear gradient brush as specified by the appearance object’s settings. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the pen used to draw the element’s background lines and curves. + + A GraphicsCache object that provides access to the pens and brushes used for painting. + An Int32 value that specifies the width of the returned Pen. + A object representing a pen specified by the appearance object’s settings. + + + + Gets the pen used to draw the element’s background lines and curves. + + A object that provides access to the pens and brushes used for painting. + A object representing a pen specified by the appearance object’s settings. + + + + Gets the brush used to draw the element’s border. + + A object that provides access to the pens and brushes used for painting. + A descendant representing a brush specified by the appearance object’s settings. + + + + Gets the element’s border color specified by the appearance object’s settings. + + A object representing the element’s border color specified by the appearance object’s settings. + + + + Returns the BorderColor (AppearanceObject.BorderColor) for the target LookAndFeel object. + + An ISkinProvider that is a LookAndFeel object whose BorderColor is to be returned. + A Color that is the BorderColor for the target LookAndFeel object. + + + + Gets the pen used to draw the element’s borders. + + A object that provides access to the pens and brushes used for painting. + An Int32 value that specifies the width of the returned Pen. + A object that is the pen specified by the appearance object’s settings. + + + + Gets the pen used to draw the border’s lines and curves. + + A object that provides access to the pens and brushes used for painting. + A object representing a pen specified by the appearance object’s settings. + + + + Returns an object that contains text alignment information and OpenType features. + + An object that contains text layout information, display manipulations, and OpenType features. + + + + Returns an object that contains text alignment information and OpenType features. + + An object with text options. + An object that contains text layout information, display manipulations, and OpenType features. + + + + Gets the font settings specified by the appearance object’s settings. + + A object specifying the font used to display the contents of elements. + + + + This member supports infrastructure and is not intended for use in code. + + + + + + + + This member supports the infrastructure and is not intended to be used directly from your code. + + + + + + + Returns the font height. + + A object that stores graphics and font settings. + An Int32 value that is the font height. + + + + Gets the solid brush whose color is specified by the AppearanceObject.ForeColor property. + + A object that provides access to the pens and brushes used for painting. + A descendant representing a brush specified by the appearance object’s settings. + + + + Gets the foreground color specified by the appearance object’s settings. + + A structure specifying the element content’s foreground color. + + + + Returns the ForeColor (AppearanceObject.ForeColor) for the target object. + + A Color that is the GraphicsCache’s foreground color. + A Color that is the ForeColor for the target object. + + + + Gets the pen whose color is specified by the AppearanceObject.ForeColor property. + + A object that provides access to the pens and brushes used for painting. + A object representing a pen specified by the appearance object’s settings. + + + + Gets the background gradient’s direction specified by the appearance object’s settings. + + A enumeration value giving the gradient’s direction as specified by the appearance object’s settings. + + + + Gets the background image specified by the appearance object’s settings. + + A object representing the element’s background image as specified by the appearance object’s settings. + + + + Gets the formatting attributes specified by the appearance object’s settings. + + A object which specifies formatting attributes, such as the line spacing and alignment. + + + + Gets the formatting attributes specified by the AppearanceObject.TextOptions object passed as the parameter. + + A object which provides the text settings. + A object which specifies formatting attributes (such as the line spacing and alignment) based on the text settings specified. + + + + Gets the formatting attributes specified by the appearance object’s settings. + + A StringFormatInfo object which specifies formatting attributes, such as the line spacing and alignment. + + + + Returns a StringFormatInfo object initialized with settings of the specified TextOptions object. + + The object used to initialize the StringFormatInfo. + The StringFormatInfo object initialized with the specified TextOptions object. + + + + Gets the text options specified by the appearance object’s settings. + + A TextOptions object containing the text options. + + + + Returns a TextureBrush object which uses the image specified by the AppearanceObject.Image property to fill the interior of a shape. + + A System.Drawing.TextureBrush object which represents the brush that fills the interior of a shape with the image specified by the AppearanceObject.Image property. + + + + Gets or sets the background gradient’s direction. + + A enumeration value specifying the gradient’s direction. + + + + Gets the horizontal alignment of the appearance object’s text. + + A enumeration value specifying the horizontal alignment of the text. + + + + Gets or sets the background image. + + A object specifying the background image. + + + + Gets whether the default font is changed. + + + + + Gets whether the current object has been disposed of. + + true if the current object has been disposed of; otherwise, false. + + + + Tests whether two objects have the same property values. + + The object to which the current object is compared. + true if the current object has the same property values as the specified object; otherwise, false. + + + + Gets or sets the name of the current appearance object. + + A value which specifies the name of the current appearance object. + + + + Provides access to the appearance object’s options. + + An object containing the appearance options. + + + + Occurs when specific settings that control the text appearance are changed. + + + + + Gets the parent appearance object. + + An object representing the parent appearance object. null (Nothing in Visual Basic) if no parent appearance object is assigned. + + + + Reverts the appearance object’s properties to their default values. + + + + + Tests whether the should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Occurs when specific settings that control the size of text are changed. + + + + + Provides access to text rendering options (horizontal and vertical alignment, word wrapping, trimming options, etc.). + + A object containing text options. + + + + Returns a string representing the current appearance object. + + A value which represents an appearance object. + + + + Represents an appearance object with extended settings. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An object implementing the IAppearanceOwner interface. + An object which represents the parent appearance object. This value is assigned to the AppearanceObject.ParentAppearance property. + A value specifying the name of the created object. This value is assigned to the AppearanceObject.Name property. + + + + Initializes a new instance of the class with the specified owner. + + An object implementing the IAppearanceOwner interface. + + + + Sets the appearance object’s settings to default values. + + An AppearanceDefault object containing default appearance settings. + + + + Creates a copy of the current instance. + + An object which represents an exact copy of the current object. + + + + Provides access to the appearance object’s options. + + An object containing the appearance options. + + + + Provides appearance options. + + + + + Initializes a new instance of the class. + + + + + Copies all settings from the options object passed as the parameter and assigns them to the current object. + + A descendant whose settings are assigned to the current object. + + + + Returns an object whose settings are not initialized. + + An object whose settings are not initialized. + + + + Tests whether two objects have the same property values. + + The object to which the current object is compared. + true if the current object has the same property values as the specified object; otherwise, false. + + + + Gets or sets whether to use the AppearanceObject.BackColor property value. + + true to use the AppearanceObject.BackColor property value; false to use the background color specified by the parent appearance object. + + + + Gets or sets whether to use the AppearanceObject.BorderColor property value. + + true to use the AppearanceObject.BorderColor property value; false to use the border color specified by the parent appearance object. + + + + Gets or sets whether to use the AppearanceObject.Font property value. + + true to use the AppearanceObject.Font property value; false to use the font settings specified by the parent appearance object. + + + + Gets or sets whether to use the AppearanceObject.ForeColor property value. + + true to use the AppearanceObject.ForeColor property value; false to use the foreground color specified by the parent appearance object. + + + + Gets or sets whether to use the AppearanceObject.Image property value. + + true to use the AppearanceObject.Image property value; false to use the background image specified by the parent appearance object. + + + + Gets or sets whether to use the AppearanceObject.TextOptions property value. + + true to use the AppearanceObject.TextOptions property value; false to use the text options specified by the parent appearance object. + + + + Provides appearance options. + + + + + Initializes a new instance of the class with default settings. + + + + + Copies all the settings from the options object passed as the parameter and assigns them to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the settings specified by the current appearance object have the highest priority. + + true to set the current appearance settings to the highest priority; otherwise, false. + + + + Serves as a base for the classes that provide the appearance settings used to paint DevExpress .NET controls. + + + + + Initializes a new instance of the class. + + + + + Copies the settings from the object passed as the parameter. + + A descendant representing the source of the operation. If null (Nothing in Visual Basic) this method does nothing. + + + + Copies the settings from the object passed as the parameter without raising the BaseAppearanceCollection.Changed event. + + A descendant representing the source of the operation. If null (Nothing in Visual Basic) this method does nothing. + + + + Locks the , preventing change notifications (and visual updates) from being raised by the object until the EndUpdate or CancelUpdate method is called. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Fires when the collection is changed. + + + + + Copies the activated appearance settings of the object passed as the parameter and activates their corresponding options, any properties not activated are set to the value in the default appearance object. + + A descendant representing the source of the operation. + An array of DevExpress.Utils.AppearanceDefaultInfo objects which represent the default appearance settings. + true to enable options which correspond to the activated appearance settings; otherwise, false. + + + + Copies the activated appearance settings of the object passed as the parameter to the current object, any properties that aren’t activated are set to the value in the default appearance object. + + A descendant representing the source of the operation. + An array of DevExpress.Utils.AppearanceDefaultInfo objects which represent the default appearance settings. + + + + Releases all the resources used by the current object. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets an appearance object contained within the collection by its name. + + A value specifying the name of the required appearance object. + The object within the collection which has the specified name. + + + + Returns an that can iterate through the hashtable. + + An for the hashtable. + + + + Gets whether the current object has been disposed of. + + true if the current object has been disposed of; otherwise, false. + + + + Indicates whether the collection’s owner is currently being initialized. + + false always. + + + + Occurs when specific settings that control the text appearance are changed. + + + + + Resets the properties of all the appearance objects within the collection to their default values. + + + + + Restores the appearance settings stored at the specified system registry path. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the system registry path. If the specified path doesn’t exist, calling this method has no effect. + + + + Restores the appearance settings from the specified stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A descendant from which the appearance settings are read. + + + + Loads the appearance settings stored in the specified XML file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the path to the XML file which contains the appearance settings to be loaded. If the specified file doesn’t exist, an exception is raised. + + + + Saves the appearance settings to a system registry path. + + A string value specifying the system registry path to which the appearance settings are saved. + + + + Saves the appearance settings to a specific stream. + + A descendant to which the appearance settings are written. + + + + Saves the appearance settings to a specific XML file. + + A string value specifying the path to the file in which the appearance settings should be stored. If an empty string is specified, an exception is raised. + + + + Tests whether the should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Occurs when specific settings that control text size are changed. + + + + + Updates the right-to-left text direction option. + + true if the text is directed from right to left; otherwise, false. + + + + Contains classes that support the Behaviors mechanism for DevExpress controls. + + + + + Attaches additional behaviors (pieces of functionality) to DevExpress controls. + + + + + A context button displaying a check box that can be checked by an end-user. + + + + + Initializes a new instance of the class. + + + + + Check Context Buttons do not have captions and therefore cannot be formatted with HTML tags. + + + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the current button is in the checked state. + + true if the current button is in the checked state; otherwise, false. + + + + Gets or sets the glyph displayed by the current button in the checked state when it is not hovered over with the mouse pointer. + + An Image object that specifies the glyph displayed by the current button. + + + + Returns the Image object specifying the checked state glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the hovered state glyph actually assigned. + + + + Returns the Image object specifying the hovered checked state glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the hovered checked state glyph actually assigned. + + + + Gets whether or not this has a checked state glyph assigned. + + true if this has a checked state glyph assigned; otherwise, false. + + + + Gets whether or not this has a hovered checked state glyph assigned. + + true if this has a hovered checked state glyph assigned; otherwise, false. + + + + Gets or sets the glyph displayed by the current button in the checked state when it is hovered over with the mouse cursor. + + An Image object that specifies the glyph displayed by the current button. + + + + This property is not supported for Check Context Buttons. + + + + + + Provides access to all properties related to the icon. + + A DevExpress.Utils.CheckContextButtonImageOptions object that stores all icon-related settings. + + + + Provides access to image-related settings for each visual state - Normal, Hovered, Checked, HoveredChecked. + + A DevExpress.Utils.CheckContextButtonImageOptionsCollection object that stores image-related settings for every visual state. + + + + A regular context button that can be clicked. + + + + + Initializes a new instance of the class. + + + + + Returns the Image object specifying the pressed state glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the pressed state glyph actually assigned. + + + + Gets whether or not this has a pressed state glyph assigned. + + true if this has a pressed state glyph assigned; otherwise, false. + + + + Provides access to all properties that allow you to assign and customize glyphs for this . + + A DevExpress.Utils.ContextButtonImageOptions object that stores all properties that allow you to assign and customize glyphs for this . + + + + Provides access to image-related settings for each visual state - Normal, Hovered, Pressed. + + A DevExpress.Utils.ContextButtonImageOptionsCollection object that stores image-related settings for every visual state. + + + + Gets or sets the glyph displayed by the current item in the normal (not hovered) state. + + An Image object that specifies the glyph displayed by the current item in the normal state. + + + + Represents a base class for context buttons. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether the current button’s caption is formatted using HTML tags. + + A enumeration value that specifies whether the current button’s caption is formatted using HTML tags. + + + + Uses the command selector to find an appropriate parameterized command in the source and binds it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and binds it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets the current button’s caption. + + A string value that specifies the current button’s caption. + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the button height. + + An integer value that specifies the button height. + + + + Fires when a hyperlink in the button caption is clicked. + + + + + Gets or sets the color of the hyperlink text in the current button’s caption. + + A Color object that specifies the color of the hyperlink text in the current button’s caption. + + + + Gets or sets the maximum height of the current button. + + An integer value that specifies the maximum height of the current button. + + + + Gets or sets the maximum width of the current button. + + An integer value that specifies the maximum width of the current button. + + + + Gets or sets the amount of space around the current button. + + A Padding structure that specifies the amount of space around the current button. + + + + Gets or sets the button width. + + An integer value that specifies the button width. + + + + Represents a base class for context items: buttons, track bars, etc. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the current item’s alignment relative to the owner control. This property is obsolete, use ContextItem.AlignmentOptions instead. + + A ContextItemAlignment enumeration value that specifies the current item’s alignment relative to the owner control. + + + + Provides access to options that specify the panel in which the item is displayed, and its position in the panel. + + A DevExpress.Utils.ContextItemAlignmentOptions object that specifies the panel in which the item is displayed, and its position in the panel. + + + + Gets or sets whether the current item’s glyph is painted using the foreground color. + + A enumeration value that specifies whether the current item’s glyph is painted using the foreground color. + + + + Gets or sets the alignment of the current item relative to the anchor element. + + An AnchorAlignment enumeration value that specifies the alignment of the current item relative to the anchor element. + + + + Gets or sets an item (anchor element) relative to which the current item is aligned. + + A relative to which the current item is aligned. + + + + Gets or sets the globally unique identifier of the item (anchor element), relative to which the current item is aligned. + + A object which represents a globally unique identifier (GUID) of the item, relative to which the current item is aligned. + + + + Gets or sets the indent between the current item and the anchor element. + + An integer value that specifies the indent, in pixels, between the current item and the anchor element. + + + + Gets or sets the translation of the current item from the anchor element. + + A Point structure by which the current item is translated. + + + + Gets or sets the type of the animation used to show and hide the current item. + + A ContextAnimationType enumeration value that specifies the type of the animation used to show and hide the current item. + + + + Provides access to appearance settings applied to this ContextItem in the Disabled state. + + Stores appearance settings for the Disabled item state. + + + + Provides access to the settings used to paint the current item in the hovered state. + + An object that provides the settings used to paint the current item. + + + + Provides access to the appearance settings used to paint the current item in the normal (not hovered) state. + + An object that provides the appearance settings used to paint the current item. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Fires when the current item is clicked. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Gets the collection to which the current item belongs. + + A ContextItemCollection object that represents the collection to which the current item belongs. + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Gets or sets whether the current item can respond to end-user interaction. + + true if the current item can respond to end-user interaction; otherwise, false. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Returns the Image object specifying the glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the glyph actually assigned. + + + + Returns the Image object specifying the hovered state glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the hovered state glyph actually assigned. + + + + Gets or sets the glyph displayed by the current item in the normal (not hovered) state. + + An Image object that specifies the glyph displayed by the current item in the normal state. + + + + Gets whether or not this has a glyph assigned. + + true if this has a glyph assigned; otherwise, false. + + + + Gets whether or not this has a hovered state glyph assigned. + + true if this has a hovered state glyph assigned; otherwise, false. + + + + Gets or sets the glyph displayed by the current item in the hovered state. + + An Image object that specifies the glyph displayed by the current item in the hovered state. + + + + Gets or sets the current item’s unique identifier. + + A object which represents a globally unique identifier (GUID). + + + + Provides access to all properties that allow you to assign and customize a glyph for this . + + A DevExpress.Utils.ContextItemImageOptions object that stores all properties that allow you to assign and customize a glyph for this . + + + + Provides access to image-related settings for each visual state. + + A DevExpress.Utils.ContextItemImageOptionsCollection object that stores image-related settings for every visual state. + + + + Gets or sets the current item’s name. + + A string value that specifies the current item’s name. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Raises the ContextItem.Click event. + + A MouseEventArgs object. + A ContextItemViewInfo object. + + + + Removes the object assigned to the current context item. + + + + + Gets or sets whether a tooltip is shown when the mouse pointer hovers over the button. + + true if a tooltip is shown when the mouse pointer hovers over the button; otherwise, false. + + + + Gets or sets the current item’s size. + + A structure that specifies the current item’s height and width. + + + + Gets or sets a super tooltip shown when the mouse pointer hovers over the button. + + A object that specifies a super tooltip shown when the mouse pointer hovers over the button. + + + + Gets or sets custom data associated with the current item. + + Custom data associated with the current item. + + + + Gets or sets the text in a regular tooltip shown when the mouse pointer hovers over the button. + + A value that specifies the text in a regular tooltip shown when the mouse pointer hovers over the button. + + + + Gets or sets the icon in a regular tooltip shown when the mouse pointer hovers over the button. + + A enumeration value that specifies the icon in a regular tooltip shown when the mouse pointer hovers over the button. + + + + Gets or sets the title in a regular tooltip shown when the mouse pointer hovers over the button. + + A value that specifies the title in a regular tooltip shown when the mouse pointer hovers over the button. + + + + Gets or sets the item visibility. + + A ContextItemVisibility enumeration value that specifies the item visibility. + + + + Provides data for the event. + + + + + Initializes a new instance of the class with specified settings. + + A related object. + A ‘s view info. + A control that contains a . + + + + Initializes a new instance of the class with specified settings. + + A related object. + A ‘s view info. + + + + Gets or sets an that contains a clicked . This object is a control or a control’s item. + + A control or a control’s item that contains a clicked + + + + Gets a clicked . + + A clicked DevExpress.Utils.ContextItem. + + + + Gets or sets a clicked ‘s ContextItemViewInfo. + + A ‘s ContextItemViewInfo + + + + Returns a that contains a . + + A that contains a . + + + + Represents a collection of objects displayed in a control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that implements the IContextItemCollectionOwner interface and that owns a new + + + + Adds a to a . + + A to be added to a . + A ‘s index in the collection. + + + + Copies settings from the target ContextItemCollection to this ContextItemCollection. + + A ContextItemCollection object whose settings are to be copied. + + + + Clones a and all objects inside it. + + An object that is a replica of a . + + + + Checks whether a contans a specific . + + The item to check. + true, if a contains a specific , otherwise, false. + + + + Returns a ‘s index within a collection. + + A whose index needs to be determined. + A ‘s index. + + + + Adds a to a specified position within a . + + An index that specifies a ‘s location. + A to add to a + + + + Gets or sets a by its index in a . + + A ‘s index in a . + A that has the specified index. + + + + Gets or sets a by its name in a . + + A ‘s name in a . + A that has the specified name. + + + + Occurs when a changes. + + + + + Provides access to the object that stores the collection’s settings. + + A object that represents a ‘s options. + + + + Gets or sets a ‘s owner. This owner implements IContextItemCollectionOwner. + + An object that implements the IContextItemCollectionOwner interface. + + + + Removes a specified from a . + + A to be removed from a . + + + + Call this method to raise a control’s CustomizeContextItems event. Handle the event to make changes to the . + + + + + Stores a ‘s settings. Use the ContextItemCollection.Options property or the control’s repository item to access them. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that implements the IContextItemCollectionOptionsOwner interface and that owns a new . + + + + Enables or disables glyph skinning for context items that display images. + + true, to match a context items‘s raster image color to the item’s text color; false to retain the original raster image color. + + + + Gets or sets whether context items support HTML tags. + + true if context items support HTML tags; otherwise, false. + + + + Gets or sets whether context items‘ tooltips support HTML tags. + + , to enable HTML formatting in DevExpress.Utils.ContextItem tooltips; , to disable; , to use the ToolTipController.AllowHtmlText setting. + + + + Gets or sets the time required to show or hide context items. + + A value that determines the time required to show or hide context items, in milliseconds. + + + + Gets or sets the animation type. The animation is displayed to show or hide context items. + + A ContextAnimationType value that determines which animation is displayed to show or hide context items. + + + + Assigns a ‘s settings to a different ContextItemCollection‘s options. + + Options to assign. + + + + Gets or sets a for a control’s bottom panel that contains context items. + + A bottom panel’s color. + + + + Gets or sets for context items inside the bottom panel. + + Bottom panel padding. + + + + Gets or sets a for a control’s center panel that contains context items. + + A center panel’s color. + + + + Gets or sets for context items inside the center panel. + + Center panel padding. + + + + Returns a copy of a object. + + A copy of a object. + + + + Gets or sets opacity for all disabled context items. + + A value between 0 and 1 that determines opacity; 1 is for “opaque”, 0 is for “transparent”. + + + + Gets or sets a for a control’s far panel that contains context items. + + A far panel’s color. + + + + Gets or sets for context items inside the far panel. + + Far panel padding. + + + + Gets or sets opacity for hovered context items. + + A value between 0 and 1 that determines opacity; 1 is for “opaque”, 0 is for “transparent”. + + + + Gets or sets the distance between context items. + + A value that determines the distance between context items. + + + + Gets or sets a cursor type for interaction. + + A cursor type for interaction. + + + + Gets or sets a for a control’s near panel that contains context items. + + A near panel’s color. + + + + Gets or sets for context items inside the near panel. + + Near panel padding. + + + + Gets or sets opacity. + + A value between 0 and 1 that determines opacity; 1 is for “opaque”, 0 is for “transparent”. + + + + An IContextItemCollectionOptionsOwner object that owns . + + An object that owns . + + + + Gets or sets a displayed when the mouse pointer hovers over a panel that contains context items + + A cursor shown when the mouse pointer hovers over a panel that contains context items. + + + + Gets or sets whether tooltips are shown when the mouse pointer hovers over context buttons. + + true, to show tooltips for context buttons; otherwise, false. + + + + Gets or sets a for a control’s top panel that contains context items. + + A top panel’s color. + + + + Gets or sets for context items inside the top panel. + + Top panel padding. + + + + Contains classes that serve as the base for objects implementing particular aspects of DevExpress controls’ functionality. + + + + + Represents the base class for most editors and controls available in the DevExpress Editors Library, along with their descendants. + + + + + Initializes a new instance of the class with default settings. + + + + + Clears the value of the size of a rectangular area, into which the specified control can fit, from the program cache. + + A Control whose size should be removed from the cache. + + + + Gets or sets the cursor that is displayed when the mouse pointer is over the control. + + The cursor that is displayed when the mouse pointer is over the control. + + + + Gets or sets the control font. + + The control font. + + + + Returns the value of the control’s CanProcessMnemonic property, if this property exists. + + The control whose CanProcessMnemonic property value is returned. + The value of the control’s CanProcessMnemonic property. true if the property doesn’t exist. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Returns the ValidationCancelled property value of a control, if this property exists. + + A that represents the control whose ValidationCancelled property value is returned. + true if the validation is cancelled; otherwise, false. + + + + Returns the parent container of the specified control that canceled validation. + + The control whose ancestor canceled validation. + The parent container control that canceled validation. + + + + Gets whether the ‘s visual elements are actually aligned to support locales using right-to-left fonts. + + true if ‘s visual elements are actually aligned to support locales using right-to-left fonts; otherwise, false. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Returns if the validates its value before the user may proceed. + + The control that needs to be checked. + true, to reset the control’s ValidationCanceled property value; otherwise, false. + true if the validates its value before the user may proceed; otherwise, false. + + + + Resets the control’s ValidationCancelled property. This method supports the internal infrastructure and is not intended to be used directly from your code. + + A control. + + + + Contains values that specify the direction of an expand button’s arrow. + + + + + Indicates the normal direction of an expand/collapse button’s arrow. + + + + + Indicates the inverted direction of an expand/collapse button’s arrow. + + + + + Defines an interface a control that can be implemented to provide layout information to a Layout Control. + + + + + The control that implements this interface must fire the Changed event when specific settings that affect the layout information have been changed, and the Layout Control must update the layout as a result. + + + + + When implemented by a control, specifies whether a text label should be visible by default when this control is added to a Layout Control. + + true if a text label should be visible by default when the control is added to a Layout Control; otherwise, false. + + + + When implemented by a control, specifies its default maximum size which is in effect when the control is displayed within a Layout Control. + + A structure that specifies the control’s default maximum size. + + + + When implemented by a control, specifies its default minimum size which is in effect when the control is displayed within a Layout Control. + + A structure that specifies the control’s default minimum size. + + + + Manages tooltips for all DevExpress controls. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container. + + An object that implements the interface. + + + + Returns the object which represents the Default ToolTipController. + + A object which represents the Default ToolTipController. + + + + Returns whether HTML formatting is enabled in tooltips for the specified control. + + A control for which this tooltip setting is to be obtained. + A value that specifies whether HTML formatting is supported in tooltips for the specified control. + + + + Gets a object associated with the specified control. + + A control whose SuperToolTip object is to be obtained. + A object associated with the control. + + + + Gets a regular tooltip’s title displayed within the specified control. + + A control whose tooltip’s title is to be obtained. + A string representing a regular tooltip’s title for the control. + + + + Gets a regular tooltip for the specified control. + + A control whose tooltip should be obtained. + A string representing a regular tooltip for the control. + + + + Gets the type of the icon displayed within the specified control’s regular tooltip. + + A control whose tooltip’s icon type is to be obtained. + A value representing the icon type displayed within the specified control’s regular tooltip. + + + + Sets whether HTML formatting is enabled in tooltips for the specified control. + + A control for which the tooltip information is to be changed. + A value that specifies whether HTML formatting is enabled in tooltips for the specified control. + + + + Associates a object with the specified control. + + A control for which to set the tooltip. + A object to associate with the control. + + + + Sets a regular tooltip’s title for the specified control. + + A control for which to set a regular tooltip’s title. + A string representing a regular tooltip’s title. + + + + Sets a regular tooltip for the specified control. + + A control for which to set the tooltip. + A string representing a regular tooltip. + + + + Sets the type of the icon displayed within the specified control’s regular tooltip. + + A control for which the icon type is set. + A value representing the type of the icon that should be displayed within the specified control’s regular tooltip. + + + + Storage that serves as an external icon source for DevExpress controls. Automatically replaces default images with their larger counterparts at higher DPI settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An IContainer descendant that owns this newly created object. + + + + Copies all available property settings from the target to this . + + A object whose settings should be copied to this . + + + + Begins the initialization. + + + + + Occurs whenever the changes its image set and allows you to respond to these changes. + + + + + Finishes the initialization. + + + + + Returns the image stored within this . + + An Int32 value that specifies the returned image’s position within this . + An Image stored within this . + + + + Returns the image stored within this . + + A String value that specifies the image name. + An Image stored within this . + + + + Provides access to default images. + + A DevExpress.Utils.DefaultImageList collection that stores default images. + + + + Gets or sets the image size that should be retrieved at the default 96 DPI setting. + + A Size structure that specifies the default image size. + + + + This is an internal property that should not be used in code. + + + + + + Gets or sets the for the object. + + The for the object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the color to treat as transparent. + + A Color object that specifies a color, which is not drawn when the image is rendered. + + + + The namespace contains types that support the Drag-and-Drop Behavior. + + + + + Provides data for the event. + + + + + Initializes a new BeginDragDropEventArgs class instance with the default settings. For internal use. + + + + + Initializes a new BeginDragDropEventArgs class instance with the specified settings. For internal use. + + true to cancel the operation; otherwise, false. + + + + Gets or sets the dragged data elements. + + An object that specifies the dragged data elements. + + + + Gets or sets a preview of dragged data elements (rows/nodes/items). + + An Image object that specifies a preview of dragged data elements. + + + + Enumerates actions available in a drag-and-drop operation. + + + + + The combination of the Copy, Move, and Scroll actions. + + + + + The data from the source control is copied to the target control. + + + + + The data from the source control is linked to the target control. + + + + + The data from the source control is moved to the target control. + + + + + The target control does not accept data. + + + + + The target control is scrolled while dragging a node to a position that is not currently visible in the target control. + + + + + Represents the Drag-and-Drop Behavior that can be attached to a data control to allow users to move/reorder data elements with the mouse. + + + + + Initializes a new DragDropBehavior class instance with the specified settings. For internal use. + + The Type of the control to which the Behavior is attached. + true to show a preview of dragged data elements; otherwise, false. + true to show where dragged data elements will be inserted; otherwise, false. + true to allow users to drop data elements on the attached control; otherwise, false. + true to allow users to drag data elements from the attached control; otherwise, false. + A DragDropEvents component that provides access to the drag-and-drop events. + + + + Returns a new Drag-and-Drop Behavior. For internal use. + + The Type of the control to which the Behavior is attached. + true to show a preview of dragged data elements; otherwise, false. + true to show where dragged data elements will be inserted; otherwise, false. + true to allow users to drop data elements on the attached control; otherwise, false. + A DragDropEvents component that provides access to drag-and-drop events. + A DragDropBehavior object that specifies the Drag-and-Drop Behavior. + + + + Returns a new Drag-and-Drop Behavior. For internal use. + + The Type of the control to which the Behavior is attached. + true to show a preview of dragged data elements; otherwise, false. + true to show where dragged data elements will be inserted; otherwise, false. + true to allow users to drop data elements on the attached control; otherwise, false. + true to allow users to drag data elements from the attached control; otherwise, false. + A DragDropEvents component that provides access to drag-and-drop events. + A DragDropBehavior object that specifies the Drag-and-Drop Behavior. + + + + Returns a new Drag-and-Drop Behavior. For internal use. + + The Type of the control to which the Behavior is attached. + true to show a preview of dragged data elements; otherwise, false. + true to show where dragged data elements will be inserted; otherwise, false. + true to allow users to drop data elements on the attached control; otherwise, false. + A DragDropBehavior object that specifies the Drag-and-Drop Behavior. + + + + Represents a base class for the Drag-and-Drop Behavior. + + A TDragDropBehaviorSource object that supports the Drag-and-Drop Behavior. + A TDragDropBehaviorProperties object that exposes the Drag-and-Drop Behavior options. + + + + Occurs when a drag-and-drop operation is initiated. + + + + + Occurs when a data element is dropped on the control. + + + + + Occurs when a data element is dragged into the control’s bounds. + + + + + Occurs when a data element is dragged out of the control’s bounds. + + + + + Occurs when a data element is dragged over the control’s bounds. + + + + + Occurs when a drag-and-drop operation is completed. + + + + + Provides access to the Drag-and-Drop Behavior options (preview, indicator, etc.). + + A TDragDropBehaviorProperties object that contains the Behavior options. + + + + Contains the Drag-and-Drop Behavior options. + + + + + Initializes a new DragDropBehaviorProperties class instance with the default settings. For internal use. + + + + + Gets or sets whether users are allowed to drag data elements from the control. + + true if users are allowed to drag data elements from the control; otherwise, false. + + + + Gets or sets whether users are allowed to drop data elements on the attached control. + + true to allow users to drop data elements on the attached control; otherwise, false. + + + + Returns a new class instance. For internal use. + + For internal use. + + + + Provides access to the Drag-and-Drop Behavior events. For internal use. + + A DragDropEvents object that contains the Drag-and-Drop Behavior events. + + + + Returns the property value. For internal use. + + For internal use. + + + + Gets or sets whether to display the indicator that shows the position in the target control where dragged elements will be inserted. + + true to show the insert indicator; otherwise, false. + + + + Gets or sets whether a preview of the dragged element is displayed during a drag-and-drop operation. + + true to display a preview of the dragged element; otherwise, false. + + + + Assigns the specified object to the property. For internal use. + + For internal use. + + + + Provides data for the event. + + + + + Initializes a new DragDropEventArgs class instance with the default settings. For internal use. + + + + + Provides access to a control’s Drag-and-Drop Behavior events. + + + + + Initializes a new DragDropEvents class instance with the default settings. For internal use. + + + + + Initializes a new DragDropEvents class instance with the specified settings. For internal use. + + An IContainer object that contains this component. + + + + Occurs when a drag-and-drop operation is initiated. + + + + + Occurs when a data element is dropped on the control. + + + + + Occurs when a data element is dragged into the control’s bounds. + + + + + Occurs when a data element is dragged out of the control’s bounds. + + + + + Occurs when a data element is dragged over the control’s bounds. + + + + + Occurs when a drag-and-drop operation is completed. + + + + + Enumerates states that specify pressed keyboard keys and mouse buttons. + + + + + The Alt key is pressed. + + + + + The Ctrl key is pressed. + + + + + The left mouse button is pressed. + + + + + The middle mouse button is pressed. + + + + + No keyboard keys or mouse buttons are pressed. + + + + + The right mouse button is pressed. + + + + + The Shift key is pressed. + + + + + Represents the Drag-and-Drop Behavior manager. + + + + + Occurs when a drag-and-drop operation is initiated. + + + + + Cancels the currently performed drag-and-drop operation. For internal use. + + + + + Provides access to the default Drag-and-Drop Behavior manager. + + A DragDropManager object that is the default Drag-and-Drop Behavior manager. + + + + Initiates a drag-and-drop operation. For internal use. + + Information about the operation. + + + + Initiates a drag-and-drop operation. For internal use. + + A source control. + Dragged data elements. + A preview of the dragged data elements. + The initial drag-and-drop effect. + + + + Occurs when a data element is dropped on the control. + + + + + Occurs when a data element is dragged into the control’s bounds. + + + + + Occurs when a data element is dragged out of the control’s bounds. + + + + + Occurs when a data element is dragged over the control’s bounds. + + + + + Occurs when a drag-and-drop operation is completed. + + + + + Gets or sets whether to indicate where dragged data elemets will be inserted. + + true to indicate where dragged data elements will be inserted; otherwise, false. + + + + Gets or sets whether a preview of dragged data elements is displayed near the mouse pointer during drag-and-drop operations. + + A PreviewImageShowMode enumeration values that specifies whether to show a preview of dragged elements. + + + + Allows you to provide a preview of the dragged data elements. + + + + + Registers the specified Drag-and-Drop Behavior. For internal use. + + An IDragDropBehavior object that specifies the Drag-and-Drop Behavior to register. + + + + Unregisters the specified Drag-and-Drop Behavior. For internal use. + + The IDragDropBehavior object specifies the Drag-and-Drop Behavior that should be unregistered. + + + + Provides data for the event. + + + + + Initializes a new DragEnterEventArgs class instance with the default settings. For internal use. + + + + + Gets or sets whether it is allowed to drop data elements to the target control. + + true to allow users to drop data elements to the target control; otherwise, false. + + + + Provides data for the event. + + + + + Initializes a new DragLeaveEventArgs class instance with the default settings. For internal use. + + + + + Gets or sets the mouse pointer. + + A Cursor enumeration value that specifies the mouse pointer. + + + + Provides data for the event. + + + + + Initializes a new DragOverEventArgs class instance with the default settings. For internal use. + + + + + Gets or sets an image that represents the insert indicator. + + An Image object that specifies the insert indicator image. + + + + Gets or sets the location of the default insert indicator. + + A Point structure that specifies the location of the default insert indicator. + + + + Gets or sets the size of the default insert indicator. + + A Size structure that specifies the size of the default insert indicator. + + + + Provides basic data for the event. + + + + + Initializes a new DragOverEventArgsBase class instance with the default settings. For internal use. + + + + + Gets or sets whether dragged data elements are inserted before or after a data element under the mouse pointer, or as a child (for tree list only). + + An InsertType enumeration value that specifies where dragged elements will be inserted. + + + + Gets or sets custom data associated with the drag-and-drop operation. + + Custom data associated with the drag-and-drop operation. + + + + Allows you to invoke or suppress actions the attached control performs on a particular drag-and-drop operation stage. + + + + + Initializes a new DXDefaultEventArgs class instance with the default settings. For internal use. + + + + + Invokes the default action the attached control performs on the current drag-and-drop operation stage. + + + + + Gets or sets whether the event was handled and allows you to suppress the default action. + + true to suppress the default action; otherwise, false. + + + + Represents a base class for drag-and-drop event arguments. + + + + + Initializes a new DXDragEventArgs class instance with the default settings. For internal use. + + + + + Gets or sets the drag-and-drop action (Copy, Move, etc.) to perform. + + A DragDropActions enumeration value that specifies the drag-and-drop action (Copy, Move, etc.) to perform. + + + + Gets or sets the mouse pointer. + + A Cursor enumeration value that specifies the mouse pointer. + + + + Gets or sets the data elements being dragged. + + An object that specifies the data elements being dragged. + + + + Returns the data elements being dragged. + + The data type. + The data type. + + + + Gets the pressed mouse buttons (left, middle, right) and modifier keys (Shift, Ctrl, Alt). + + A DragDropKeyState enumeration value that specifies the pressed mouse buttons and modifier keys. + + + + Gets the mouse cursor’s position. + + A Point structure that specifies the mouse pointer’s position. + + + + Gets the source control. + + An object that specifies the source control. + + + + Gets the target control. + + An object that specifies the target control. + + + + Enumerates types that specify how to drop dragged data elements based on the mouse pointer’s position. + + + + + Drop the dragged data element after the data element under the mouse pointer. + + + + + Drop the dragged data element as a child of the data element under the mouse pointer (tree list only). + + + + + Drop the dragged data element before the data element under the mouse pointer. + + + + + It is not allowed to drop data elemements on the target control. + + + + + Enumerates modes that specify whether to show a preview of dragged elements next to the mouse pointer. + + + + + A preview of the dragged data element is always displayed. + + + + + A preview of the dragged data element is only displayed when a user drag it over the target control. + + + + + A preview of the dragged data element is never displayed. + + + + + Provides data for the DragDropManager.QueryDragPreviewImage event. + + + + + Initializes a new QueryDragPreviewImageEventArgs class instance with the default settings. For internal use. + + + + + Gets the drag-and-drop action (Copy, Move, etc.) to perform. + + A DragDropActions enumeration value that specifies the drag-and-drop action (Copy, Move, etc.) to perform. + + + + Gets or sets whether dragged data elements will be inserted before or after data element under the mouse pointer, or as a child (for tree list only). + + An InsertType enumeration value that specifies where dragged elements will be inserted. + + + + Gets the pressed mouse buttons (left, middle, right) and modifier keys (Shift, Ctrl, Alt). + + A DragDropKeyState enumeration value that specifies the pressed mouse buttons and modifier keys. + + + + Gets or sets a preview of dragged data elements (rows/nodes/items). + + An Image object that specifies a preview of dragged data elements. + + + + Gets the source control. + + An object that specifies the source control. + + + + Gets the target control. + + An object that specifies the target control. + + + + Contains classes that provide painting facilities for DevExpress controls. + + + + + Provides methods to paint on drawing surfaces in GDI+ and DirectX modes (see DirectX hardware acceleration). + Provides storage for pens, fonts and brushes. + + + + + This value is assigned to the GraphicsCache.PaintArgs property. + + A PaintEventArgs object that contains data used for painting. This value is assigned to the GraphicsCache.PaintArgs property. + A ScaleHelper object used to appropriately adjust the values for font and drawing APIs. This value is assigned to the GraphicsCache.ScaleDPI property. + + + + This value is assigned to the GraphicsCache.PaintArgs property. + + A PaintEventArgs object that contains data used for painting. This value is assigned to the GraphicsCache.PaintArgs property. + A DevExpress.Utils.Paint.XPaint object associated with this object. + A ScaleHelper object used to appropriately adjust the values for font and drawing APIs. This value is assigned to the GraphicsCache.ScaleDPI property. + + + + Initializes a new instance of the class + + A DevExpress.Utils.Drawing.DXPaintEventArgs object that contains data used to perform painting. This value is assigned to the GraphicsCache.PaintArgs property. + A DevExpress.Utils.Paint.XPaint object that provides methods used for drawing objects. This value is assigned to the GraphicsCache.Paint property. + + + + Initializes a new instance of the class. + + A DevExpress.Utils.Drawing.DXPaintEventArgs object that contains data used to perform painting. This value is assigned to the GraphicsCache.PaintArgs property. + + + + This value is assigned to the GraphicsCache.PaintArgs property. + + A Graphics object that serves as the painting surface and provides painting facilities. This value is assigned to the GraphicsCache.Graphics property. + A ScaleHelper object used to appropriately adjust the values for font and drawing APIs. This value is assigned to the GraphicsCache.ScaleDPI property. + + + + Creates an instance of the class. + + The object to initialize the GraphicsCache.Graphics property. + + + + Initializes a new instance of the class with the specified settings. + + A PaintEventArgs object that contains data used for painting. This value is assigned to the GraphicsCache.PaintArgs property. + A ScaleHelper object used to appropriately adjust the values for font and drawing APIs. This value is assigned to the GraphicsCache.ScaleDPI property. + + + + Creates an instance of the class. + + A object that contains data used for painting. This value is assigned to the GraphicsCache.PaintArgs property. + A DevExpress.Utils.Paint.XPaint object providing painting methods used in the control. This value is assigned to the GraphicsCache.Paint property. + + + + Initializes a new instance of the class. + + A object that contains data used to paint. + + + + Returns the name of a currently applied Application Skin. + + A String value that is the applied skin’s name. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A DevExpress.Utils.Drawing.ResourceCache object. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure. + A structure. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure. + A structure. + + + + Calculates the size of the specified string when it’s drawn with the specified font. + + A value which represents a string to measure. + A object which defines the font and the associated settings of the text. + A structure that specifies the maximum layout area for the text. + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string when it’s drawn with the specified font and using the specified formatting. + + A value which represents a string to measure. + A object which defines the font and the associated settings of the text. + A object which represents formatting information, such as the line spacing and alignment, of the string. + A structure that specifies the maximum layout area for the text. + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string when it’s drawn with the specified font and using the specified formatting, fitting the string into a clipping rectangle. Allows you to determine whether the string does not fit the clipping rectangle. + + The string to be measured. + The font in which to paint the string. + Contains formatting information, such as the line spacing and alignment of the string. + The maximum width of the clipping rectangle that will fit the string (in pixels). + The maximum height of the clipping rectangle that will fit the string (in pixels). + A value that specifies whether the text is trimmed (its size is larger than the clipping rectangle). + The measured size of the string, in pixels. + + + + Calculates the size of the specified string when it’s drawn with the specified font and formatting, fitting the string into a clipping rectangle. + + The string to be measured. + The font in which to paint the string. + Contains formatting information, such as the line spacing and alignment of the string. + The maximum width of the clipping rectangle that will fit the string (in pixels). + The maximum height of the clipping rectangle that will fit the string (in pixels). + The measured size of the string, in pixels. + + + + Calculates the size of the specified string when it is drawn with the specified font and formatting. + + A value that specifies the string to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A object that specifies the text format, such as the line spacing and alignment. + An integer value that specifies the maximum width, in pixels, of the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it’s drawn with the specified font. + + A value which represents a string to measure. + A object which defines the font and the associated settings of the text. + An integer value specifying the maximum width of the string (in pixels). + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string when it’s drawn with the specified font. + + A value which represents a string to measure. + A object which defines the font and the associated settings of the text. + A structure which represents the size (in pixels) of the string. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A structure that specifies the maximum layout area for the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A object that specifies the text format, such as the line spacing and alignment. + A structure that specifies the maximum layout area for the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A object that specifies the text format, such as the line spacing and alignment. + An integer value that specifies the maximum width, in pixels, of the text. + An integer value that specifies the maximum height, in pixels, of the text. + A value that specifies whether the text is trimmed (its size is larger than the clipping rectangle). + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A object that specifies the text format, such as the line spacing and alignment. + An integer value that specifies the maximum width, in pixels, of the text. + An integer value that specifies the maximum height, in pixels, of the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A object that specifies the text format, such as the line spacing and alignment. + An integer value that specifies the maximum width, in pixels, of the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + An integer value that specifies the maximum width, in pixels, of the text. + A structure that specifies the text size in pixels. + + + + Calculates the size of the specified string when it is drawn vertically with the specified font and format. + + A value that specifies the text to measure. + A object that specifies the font settings (face, size, style) used to draw the text. + A structure that specifies the text size (in pixels). + + + + Clears the internal hash tables that store the pens, fonts and, solid and linear gradient brushes that have recently been used. + + + + + Clears the entire drawing surface and fills it with the specified background color. + + A Color structure that represents the background color of the drawing surface. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A DevExpress.Utils.Drawing.GraphicsClip object. + + + + Gets a value that specifies how composited images are drawn to the cached GraphicsCache.Graphics. + + One of the values. + + + + Gets or sets the rendering quality of composited images drawn to the cached GraphicsCache.Graphics. + + One of the values. + + + + Returns a 3-by-3 affine matrix that represents a geometric transform. + + An object that represents a geometric transform. + + + + Returns a 3-by-3 affine matrix that represents a geometric transform. + + The value in the first row and first column of the new matrix. + The value in the first row and second column of the new matrix. + The value in the second row and first column of the new matrix. + The value in the second row and second column of the new matrix. + The value in the third row and first column of the new matrix. + The value in the third row and second column of the new matrix. + An object that represents a geometric transform. + + + + Returns a new series of connected lines and curves. + + An object that specifies a series of connected lines and curves. + + + + Creates a rectangular path with rounded corners. + + The rectangle that specifies the path. + The corner radius for the rectangle. + The resulting GraphicsPath object. + + + + Returns the current display DPI value. + + The current display DPI value. + + + + Releases all resources used by this object. + + + + + Draws an arc representing a portion of an ellipse specified by a structure. + + that determines the color, width, and style of the arc. + structure that defines the boundaries of the ellipse. + Angle in degrees measured clockwise from the x-axis to the starting point of the arc. + Angle in degrees measured clockwise from the startAngle parameter to ending point of the arc. + + + + Draws an arc representing a portion of an ellipse specified by a structure. + + that determines the color, width, and style of the arc. + structure that defines the boundaries of the ellipse. + Angle in degrees measured clockwise from the x-axis to the starting point of the arc. + Angle in degrees measured clockwise from the startAngle parameter to ending point of the arc. + + + + Draws an arc representing a portion of an ellipse specified by a pair of coordinates, a width, and a height. + + that determines the color, width, and style of the arc. + The x-coordinate of the upper-left corner of the rectangle that defines the ellipse. + The y-coordinate of the upper-left corner of the rectangle that defines the ellipse. + Width of the rectangle that defines the ellipse. + Height of the rectangle that defines the ellipse. + Angle in degrees measured clockwise from the x-axis to the starting point of the arc. + Angle in degrees measured clockwise from the startAngle parameter to ending point of the arc. + + + + Draws an arc representing a portion of an ellipse specified by a pair of coordinates, a width, and a height. + + that determines the color, width, and style of the arc. + The x-coordinate of the upper-left corner of the rectangle that defines the ellipse. + The y-coordinate of the upper-left corner of the rectangle that defines the ellipse. + Width of the rectangle that defines the ellipse. + Height of the rectangle that defines the ellipse. + Angle in degrees measured clockwise from the x-axis to the starting point of the arc. + Angle in degrees measured clockwise from the startAngle parameter to ending point of the arc. + + + + Draws a Bezier spline defined by four structures. + + structure that determines the color, width, and style of the curve. + structure that represents the starting point of the curve. + structure that represents the first control point for the curve. + structure that represents the second control point for the curve. + structure that represents the ending point of the curve. + + + + Draws a Bezier spline defined by four structures. + + structure that determines the color, width, and style of the curve. + structure that represents the starting point of the curve. + structure that represents the first control point for the curve. + structure that represents the second control point for the curve. + structure that represents the ending point of the curve. + + + + Draws a Bezier spline defined by four ordered pairs of coordinates that represent points. + + that determines the color, width, and style of the curve. + The x-coordinate of the starting point of the curve. + The y-coordinate of the starting point of the curve. + The x-coordinate of the first control point of the curve. + The y-coordinate of the first control point of the curve. + The x-coordinate of the second control point of the curve. + The y-coordinate of the second control point of the curve. + The x-coordinate of the ending point of the curve. + The y-coordinate of the ending point of the curve. + + + + Draws a series of Bezier splines from an array of structures. + + that determines the color, width, and style of the curve. + Array of structures that represent the points that determine the curve. The number of points in the array should be a multiple of 3 plus 1, such as 4, 7, or 10. + + + + Draws a series of Bezier splines from an array of structures. + + that determines the color, width, and style of the curve. + Array of structures that represent the points that determine the curve. The number of points in the array should be a multiple of 3 plus 1, such as 4, 7, or 10. + + + + Draws an ellipse specified by a bounding Rectangle structure. + + A Pen object that specifies the ellipse color, style and line thickness. + A Rectangle structure that defines the ellipse boundaries. + + + + Draws an ellipse specified by a bounding RectangleF structure. + + A Pen object that specifies the ellipse color, style and line thickness. + A Rectangle structure that defines the ellipse boundaries. + + + + Draws an ellipse defined by a bounding rectangle specified by the rectangle upper-left corner coordinates, a height, and a width. + + An Int32 value that is the x-coordinate of the bounding rectangle’s upper-left corner. + An Int32 value that is the y-coordinate of the bounding rectangle’s upper-left corner. + An Int32 value that is the bounding rectangle width. + An Int32 value that is the bounding rectangle height. + An ellipse color. + An Int32 value that specifies the ellipse line thickness. + + + + Draws an ellipse defined by a bounding rectangle specified by a coordinate pair, a height, and a width. + + A Single value that is the x-coordinate of the bounding rectangle’s upper-left corner. + A Single value that is the y-coordinate of the bounding rectangle’s upper-left corner. + A Single value that is the bounding rectangle width. + A Single value that is the bounding rectangle height. + An ellipse color. + An Int32 value that specifies the ellipse line thickness. + + + + Draws a focus rectangle on the specified graphics surface and within the specified bounds. + + The Graphics surface to draw on. + The dimensions of the focus area. + The foreground color of the object to draw the focus rectangle on. + The background color of the object to draw the focus rectangle on. + + + + Draws a focus rectangle within the specified bounds. + + The dimensions of the focus area. + The foreground color of the object to draw the focus rectangle on. + The background color of the object to draw the focus rectangle on. + + + + Draws the image represented by the specified within the area specified by a structure. + + to draw. + structure that specifies the location and size of the resulting image on the display surface. The image contained in the icon parameter is scaled to the dimensions of this rectangular area. + + + + Draws the image represented by the specified at the specified coordinates. + + to draw. + The x-coordinate of the upper-left corner of the drawn image. + The y-coordinate of the upper-left corner of the drawn image. + + + + Draws the image represented by the specified without scaling the image. + + to draw. + structure that specifies the location and size of the resulting image. The image is not scaled to fit this rectangle, but retains its original size. If the image is larger than the rectangle, it is clipped to fit inside it. + + + + Draws the Image at the specified location and with the specified size. + + An Image to draw. + A Point structure that specifies the image upper-left corner’s location. + + + + Draws the specified Image portion at the specified location and with the specified size. + + An Image to draw. + An array of three Point structures that define a parallelogram. + A Rectangle structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the Image portion at the specified location and with the specified size. + + An Image to draw. + An array of three PointF structures that define a parallelogram. + A RectangleF structure that specifies the image portion to be drawn. + A color-adjustment matrix for the default category. + + + + Draws the specified Image at the specified location and with the specified shape and size. + + An Image to draw. + An array of three Point structures that define a parallelogram. + + + + Draws the Image with its original physical size and at the specified location. + + An Image to draw. + A PointF structure that specifies the image upper-left corner’s location. + + + + Draws the Image portion at the specified location and with the specified size. + + An Image to draw. + An array of three PointF structures that define a parallelogram. + A RectangleF structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the portion of the specified Image at the specified location and with the specified size. + + An Image to draw. + An array of three Point structures that define a parallelogram. + A Rectangle structure that specifies the image portion to be drawn. + A color-adjustment matrix for the default category. + + + + Draws the specified Image at the specified location and with the specified shape and size. + + An Image to draw. + An array of three PointF structures that define a parallelogram. + + + + Draws the specified Image portion with the specified size. + + An Image to draw. + A Rectangle structure that specifies the drawn image’s location and size. The image is scaled to fit the rectangle. + A Rectangle structure that specifies the image portion to be drawn. + true if the image should be painted as is; false to draw a grayed-out “disabled” image. + + + + Draws the portion of the specified Image at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the drawn image’s location and size. The image is scaled to fit the rectangle. + A Rectangle structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the portion of the specified Image at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the drawn image’s location and size. The image is scaled to fit the rectangle. + A Rectangle structure that specifies the image portion to be drawn. + A color-adjustment matrix for the default category. + + + + Draws the specified Image portion at the specific coordinates and with the specified attributes and size. + + An Image to draw. + A Rectangle structure that specifies the drawn image’s location and size. The image is scaled to fit the rectangle. + A Rectangle structure that specifies the image portion to be drawn. + A System.Drawing.Imaging.ImageAttributes object that specifies recoloring and gamma information for the image object. + + + + Draws an Image portion at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the image location and size. The image is scaled to fit this rectangle. + An Int32 value that is the x-coordinate of the image portion’ upper-left corner. + An Int32 value that is the y-coordinate of the image portion’ upper-left corner. + An Int32 value that is the x-coordinate the image portion’s width. + An Int32 value that is the image portion’ height. + A GraphicsUnit enumeration value that specifies the measure units for the x, y, width and height parameters. + + + + Draws an Image portion at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the image location and size. The image is scaled to fit this rectangle. + A Single value that is the x-coordinate of the image portion’s upper-left corner. + A Single value that is the y-coordinate of the image portion’s upper-left corner. + A Single value that is the image portion’s width. + A Single value that is the image portion’s height. + A GraphicsUnit enumeration value that specifies the measure units for the srcX, srcY, srcHeight and srcWidth parameters. + + + + Draws an Image portion at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the image location and size. The image is scaled to fit this rectangle. + A Single value that is the x-coordinate of the image portion’s upper-left corner. + A Single value that is the y-coordinate of the image portion’s upper-left corner. + A Single value that is the image portion’s width. + A Single value that is the image portion’s height. + A color-adjustment matrix for the default category. + + + + Draws the specified Image at the specified location and with the specified size. + + An Image to draw. + A Rectangle structure that specifies the image location and size. + + + + Draws an Image portion at the specified location and with the specified size. + + An Image to draw. + A RectangleF structure that specifies the image location and size. The image is scaled to fit this rectangle. + A RectangleF structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the Image at the specified location and with the specified size. + + An Image to draw. + A RectangleF structure that specifies the image location and size. + + + + Draws the specified Image portion at the specific coordinates and with the specified size. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + A Rectangle structure that specifies the image portion to be drawn. + true if the image should be painted as is; false to draw a grayed-out “disabled” image. + + + + Draws an image portion at a specified location. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + A Rectangle structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the given images at specific coordinates and with specific size. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + An Int32 value that is the image width. + An Int32 value that is the image height. + + + + Draws the specified Image with its original physical size, at the location specified by a coordinate pair. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + + + + Draws an image portion at the specified location. + + An Image to draw. + An Single value that is the x-coordinate of the image upper-left corner. + An Single value that is the y-coordinate of the image upper-left corner. + A RectangleF structure that specifies the image portion to be drawn. + A GraphicsUnit enumeration value that specifies the measure units for the srcRect parameter. + + + + Draws the Image at the specific location and with the specific size. + + An Image to draw. + An Single value that is the x-coordinate of the image upper-left corner. + An Single value that is the y-coordinate of the image upper-left corner. + An Single value that is the image width. + An Single value that is the image height. + + + + Draws the Image using its original physical size and at the specified location. + + An Image to draw. + An Single value that is the x-coordinate of the image upper-left corner. + An Single value that is the y-coordinate of the image upper-left corner. + + + + Draws an image at the specific location using its original physical size. + + An Image to draw. + A Point structure that specifies the image upper-left corner location. + + + + Draws an image at the specific location using its original physical size. + + An Image to draw. + A Rectangle structure, whose X and Y properties specify the image upper-left corner coordinates, and Width and Height properties are ignored. + + + + Draws an image at the specific location using its original physical size. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + Not used. + Not used. + + + + Draws an image using its original physical size at the location specified by a coordinate pair. + + An Image to draw. + An Int32 value that is the x-coordinate of the image upper-left corner. + An Int32 value that is the y-coordinate of the image upper-left corner. + + + + Draws a line on the current painting surface connecting two Point structures. + + A Pen object specifying the Pen used to draw the line. + A Point structure that represents the first point to connect. + A Point structure that represents the second point to connect. + + + + Draws a line connecting two structures. + + A object that specifies the color, width, and style of the line. + A structure that represents the first point to connect. + A structure that represents the second point to connect. + + + + Draws a line connecting two Point structures. + + Point structure that represents the first point to connect. + Point structure that represents the second point to connect. + A Color structure that indicates the color of the Pen used to draw the line. + A value indicating the width of the Pen used to draw the line. + + + + Draws a line connecting two PointF structures. + + A PointF structure that represents the first point to connect. + A PointF structure that represents the second point to connect. + A Color structure that indicates the color of the Pen used to draw the line. + A value indicating the width of the Pen used to draw the line. + + + + Draws a line connecting two Point structures. + + The x-coordinate of the Point structure that represents the first point to connect. + The y-coordinate of the Point structure that represents the first point to connect. + The x-coordinate of the Point structure that represents the second point to connect. + The y-coordinate of the Point structure that represents the second point to connect. + A Color structure that indicates the color of the Pen used to draw the line. + A value indicating the width of the Pen used to draw the line. + + + + Draws a line connecting two PointF structures. + + The x-coordinate of the PointF structure that represents the first point to connect. + The y-coordinate of the PointF structure that represents the first point to connect. + The x-coordinate of the PointF structure that represents the second point to connect. + The y-coordinate of the PointF structure that represents the second point to connect. + A Color structure that indicates the color of the Pen used to draw the line. + A value indicating the width of the Pen used to draw the line. + + + + Draws a series of lines that connect given points. + + Specifies the color and width for the drawn lines. + The array of points that should be connected with lines. + + + + Draws a polygon defined by an array of Point structures. + + Array of Point structures that represent the vertices of the polygon. + A Color structure that indicates the color of the Pen used to draw the lines. + A value indicating the width of the Pen used to draw the lines. + + + + Draws a polygon defined by an array of PointF structures. + + Array of PointF structures that represent the vertices of the polygon. + A Color structure that indicates the color of the Pen used to draw the lines. + A value indicating the width of the Pen used to draw the lines. + + + + Draws a . + + A object that specifies the color, width, and style of the path. + An object that wraps a object to draw. + + + + Draws a . + + that determines the color, width, and style of the path. + to draw. + + + + Draws a pie shape defined by an ellipse specified by a structure and two radial lines. + + that determines the color, width, and style of the pie shape. + structure that represents the bounding rectangle that defines the ellipse from which the pie shape comes. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Draws a pie shape defined by an ellipse specified by a structure and two radial lines. + + that determines the color, width, and style of the pie shape. + structure that represents the bounding rectangle that defines the ellipse from which the pie shape comes. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Draws a pie shape defined by an ellipse specified by a coordinate pair, a width, a height, and two radial lines. + + that determines the color, width, and style of the pie shape. + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie shape comes. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie shape comes. + Width of the bounding rectangle that defines the ellipse from which the pie shape comes. + Height of the bounding rectangle that defines the ellipse from which the pie shape comes. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Draws a pie shape defined by an ellipse specified by a coordinate pair, a width, a height, and two radial lines. + + that determines the color, width, and style of the pie shape. + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie shape comes. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie shape comes. + Width of the bounding rectangle that defines the ellipse from which the pie shape comes. + Height of the bounding rectangle that defines the ellipse from which the pie shape comes. + Angle measured in degrees clockwise from the x-axis to the first side of the pie shape. + Angle measured in degrees clockwise from the startAngle parameter to the second side of the pie shape. + + + + Draws a polygon defined by an array of Point structures. + + Array of Point structures that represent the vertices of the polygon. + A Color structure that indicates the color of the Pen used to draw the polygon. + A value indicating the width of the Pen used to draw the polygon. + + + + Draws a polygon defined by an array of PointF structures. + + Array of PointF structures that represent the vertices of the polygon. + A Color structure that indicates the color of the Pen used to draw the polygon. + A value indicating the width of the Pen used to draw the polygon. + + + + Draws a rectangle specified by a structure. + + A object which specifies the color, width and style of the rectangle. + + + + Draws a . + + A object that specifies the color, width, and style of the rectangle. + A structure that represents the rectangle to draw. + + + + Draws a rectangle specified by a structure. + + A structure that represents the rectangle to draw. + A structure that indicates the color of the Pen used to draw the rectangle. + A value indicating the width of the Pen used to draw the rectangle. + + + + Draws a rectangle specified by a pair of coordinates, a width, and a height. + + The x-coordinate of the upper-left corner of the rectangle to draw. + The y-coordinate of the upper-left corner of the rectangle to draw. + Width of the rectangle to draw. + Height of the rectangle to draw. + A structure that indicates the color of the Pen used to draw the rectangle. + A value indicating the width of the Pen used to draw the rectangle. + + + + Draws a rectangle with the specified border color and thickness. + + An Single value that is the top left corner’s x-coordinate. + An Single value that is the top left corner’s y-coordinate. + A Single value that is the rectangle width. + A Single value that is the rectangle height. + A Color object that specifies the border color. + An Int32 value that specifies the border thickness. + + + + Draws a series of rectangles specified by structures. + + Array of structures that represent the rectangles to draw. + A structure that indicates the color of the Pen used to draw the rectangles. + A value indicating the width of the Pen used to draw the rectangles. + + + + Draws a series of rectangles specified by structures. + + Array of structures that represent the rectangles to draw. + A structure that indicates the color of the Pen used to draw the rectangles. + A value indicating the width of the Pen used to draw the rectangles. + + + + Draws a rectangle with rounded corners. + + The rectangle border color. + The rectangle border width. + The rectangle to draw. + The radius of rectangle corners. + + + + Draws a rectangle with rounded corners. + + A Pen that determines the rectangle color, width, and style. + The rectangle to draw. + The radius of rectangle corners. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects using the specified formatting attributes. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + PointF structure that specifies the upper-left corner of the drawn text. + StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects using the formatting attributes of the specified StringFormat. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + PointF structure that specifies the upper-left corner of the drawn text. + StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + PointF structure that specifies the upper-left corner of the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects using the specified formatting attributes. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + Rectangle structure that specifies the location of the drawn text. + StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws a text string at the specified position using the specified font, color and format. + + A value representing the text to be drawn. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A structure which represents the drawing area. + A object which specifies formatting attributes, such as the line spacing and alignment, that are applied to the drawn text. + + + + Draws a string with custom parameters. + + Text to draw. + The text font. + The Brush to paint the text string. + Specifies the text string location. + A StringFormatInfo object that stores line spacing, alignment, and other formatting setting for the string. + + + + Draws the specified text string in the specified rectangle with the specified Brush and Font objects. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + RectangleF structure that specifies the location of the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + The x-coordinate of the upper-left corner of the drawn text. + The y-coordinate of the upper-left corner of the drawn text. + StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects using the formatting attributes of the specified StringFormat. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + The x-coordinate of the upper-left corner of the drawn text. + The y-coordinate of the upper-left corner of the drawn text. + StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string at the specified location with the specified Brush and Font objects. + + String to draw. + Font that defines the text format of the string. + Brush that determines the color and texture of the drawn text. + The x-coordinate of the upper-left corner of the drawn text. + The y-coordinate of the upper-left corner of the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Brush and Font objects using the specified formatting attributes. + + String to draw. + Font that defines the text format of the string. + Color of the drawn text. + Rectangle structure that specifies the location of the drawn text. + StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Brush and Font objects using the specified formatting attributes. + + String to draw. + Font that defines the text format of the string. + Color of the drawn text. + Rectangle structure that specifies the location of the drawn text. + StringFormatInfo object that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Brush and Font objects using the specified formatting attributes. + + String to draw. + Font that defines the text format of the string. + Color of the drawn text. + RectangleF structure that specifies the location of the drawn text. + StringFormatInfo that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws the specified text string in the specified rectangle with the specified Brush and Font objects using the formatting attributes of the specified StringFormat. + + String to draw. + Font that defines the text format of the string. + Color of the drawn text. + RectangleF structure that specifies the location of the drawn text. + StringFormat that specifies formatting attributes, such as line spacing and alignment, that are applied to the drawn text. + + + + Draws a vector image at the given coordinates. + + The image to draw. + Specifies the coordinates of the drawn image. + An object that retrieves vector skin palettes. Vector image colors are slightly adjusted depending on the active palette. + The relation of the final image size to the original size of the source image. + + + + Draws a vector image at the given coordinates. + + The vector image to draw. + A Point structure that specifies the coordinates for the drawn image. + An object that retrieves vector skin palettes. Vector image colors are slighly adjusted depending on the active palette. + + + + Draws a vector image + + The image to draw. + A Rectangle structure that specifies the location and size of the drawn image. The image is scaled to fit the rectangle. + An object that retrieves vector skin palettes. Vector image colors are slighly adjusted depending on the active palette. + + + + Draws a text string vertically with the specified angle and at the specified position using the specified font, color and format. + + A value which represents the text to be drawn. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A structure which represents the drawing area. + A StringFormatInfo object which specifies formatting attributes such as the line spacing and alignment that are applied to the drawn text. + An integer value specifying the angle in degrees at which the text should be drawn. + + + + Draws a text string vertically with the specified angle and at the specified position using the specified font, color and format. + + A value which represents the text to be drawn. + A object which defines the font and associated settings of the text to be drawn. + A object which specifies the color and texture of the drawn text. + A structure which represents the drawing area. + A object which specifies formatting attributes such as the line spacing and alignment that are applied to the drawn text. + An integer value specifying the angle in degrees at which the text should be drawn. + + + + Allows the target painter to utilize the DirectX API. + + A DirectXPaint object that is the target painter. + + + + Fills the interior of an ellipse defined by a bounding rectangle specified by a structure. + + A object that specifies the characteristics of the fill. + A structure that represents the bounding rectangle that defines the ellipse. + + + + Fills the interior of an ellipse defined by a bounding rectangle specified by a structure. + + A structure that indicates the color of the from the current cache that determines the characteristics of the fill. + A structure that represents the bounding rectangle that defines the ellipse. + + + + Fills the interior of an ellipse defined by a bounding rectangle specified by a structure. + + A structure that indicates the color of the from the current cache that determines the characteristics of the fill. + A structure that represents the bounding rectangle that defines the ellipse. + + + + Fills the interior of an ellipse defined by a bounding rectangle specified by a pair of coordinates, a width, and a height. + + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse. + Width of the bounding rectangle that defines the ellipse. + Height of the bounding rectangle that defines the ellipse. + A structure that indicates the color of the from the current cache that determines the characteristics of the fill. + + + + Fills the interior of an ellipse defined by a bounding rectangle specified by a pair of coordinates, a width, and a height. + + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse. + Width of the bounding rectangle that defines the ellipse. + Height of the bounding rectangle that defines the ellipse. + Brush that determines the characteristics of the fill. + + + + Fills the interior of a . + + A object that determines the characteristics of the fill. + An object that wraps a object that represents the path to fill. + + + + Fills the interior of a . + + that determines the characteristics of the fill. + that represents the path to fill. + + + + Fills the interior of a pie section defined by an ellipse specified by a structure and two radial lines. + + that determines the characteristics of the fill. + structure that represents the bounding rectangle that defines the ellipse from which the pie section comes. + Angle in degrees measured clockwise from the x-axis to the first side of the pie section. + Angle in degrees measured clockwise from the startAngle parameter to the second side of the pie section. + + + + Fills the interior of a pie section defined by an ellipse specified by a pair of coordinates, a width, a height, and two radial lines. + + that determines the characteristics of the fill. + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie section comes. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie section comes. + Width of the bounding rectangle that defines the ellipse from which the pie section comes. + Height of the bounding rectangle that defines the ellipse from which the pie section comes. + Angle in degrees measured clockwise from the x-axis to the first side of the pie section. + Angle in degrees measured clockwise from the startAngle parameter to the second side of the pie section. + + + + Fills the interior of a pie section defined by an ellipse specified by a pair of coordinates, a width, a height, and two radial lines. + + that determines the characteristics of the fill. + The x-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie section comes. + The y-coordinate of the upper-left corner of the bounding rectangle that defines the ellipse from which the pie section comes. + Width of the bounding rectangle that defines the ellipse from which the pie section comes. + Height of the bounding rectangle that defines the ellipse from which the pie section comes. + Angle in degrees measured clockwise from the x-axis to the first side of the pie section. + Angle in degrees measured clockwise from the startAngle parameter to the second side of the pie section. + + + + Fills the interior of a polygon defined by an array of points specified by Point structures. + + Array of Point structures that represent the vertices of the polygon to fill. + A Color structure that specifies the color of the fill. + + + + Fills the interior of a polygon defined by an array of points specified by PointF structures. + + Array of PointF structures that represent the vertices of the polygon to fill. + A Color structure that specifies the color of the fill. + + + + Fills the interior of a rectangle specified by a structure. + + An object specifying the background color used to fill the rectangle. + A structure which represents the rectangle to fill. + + + + Fills the interior of a rectangle specified by a structure. + + A object which represents the brush used to fill the rectangle. + A value which represents the rectangle to fill. + + + + Fills the interior of a rectangle specified by a structure. + + A object which represents the brush used to fill the rectangle. + A value which represents the rectangle to fill. + + + + Fills the interior of a rectangle specified by a pair of coordinates, a width, and a height. + + that determines the characteristics of the fill. + The x-coordinate of the upper-left corner of the rectangle to fill. + The y-coordinate of the upper-left corner of the rectangle to fill. + Width of the rectangle to fill. + Height of the rectangle to fill. + + + + Fills the interior of a rectangle specified by a pair of coordinates, a width, and a height. + + that determines the characteristics of the fill. + The x-coordinate of the upper-left corner of the rectangle to fill. + The y-coordinate of the upper-left corner of the rectangle to fill. + Width of the rectangle to fill. + Height of the rectangle to fill. + + + + Fills the specified rectangular area with the specified color. + + A value that specifies the filling color. + A value which represents the rectangle to be filled. + + + + Fills the interior of a rectangle specified by a structure. + + A structure that represents the color of this brush used to fill the rectangle. + A structure which represents the rectangle to fill. + + + + Fills the interiors of multiple rectangles. This method is the HDPI-compatible counterpart of the standard Graphics.FillRectangles method. + + The brush that specifies fill settings. + Rectangles that should be filled. + + + + Fills the interiors of a series of rectangles specified by structures. + + A structure that indicates the color of the from the current cache that determines the characteristics of the fill. + Array of structures that represent the rectangles to fill. + + + + Fills the interiors of a series of rectangles specified by structures. + + A structure that indicates the color of the from the current cache that determines the characteristics of the fill. + Array of structures that represent the rectangles to fill. + + + + Draws a rectangle with rounded corners and fills it with the specified color. + + The rectangle color. + The rectangle to draw. + The radius of rectangle corners. + + + + Gets a font object with the specified settings. + + A object whose settings specify the desired font’s typeface and size. + A bitwise combination of enumeration values specifying the desired font style. + A object representing a font with the specified settings. + + + + Returns a linear gradient brush with the specified settings. + + A structure that specifies the endpoints of the linear gradient. The starting point is the upper-left corner of the rectangle, and the endpoint is the upper-right corner of the rectangle. + A object that represents the starting color for the gradient. + A object that represents the ending color for the gradient. + A enumeration value specifying the gradient’s orientation. + An integer value specifying the number of blend patterns for the brush. + A descendant representing the requested linear gradient brush (typically a System.Drawing.Drawing2D.LinearGradientBrush object). + + + + Returns a linear gradient brush with specified settings. + + A System.Drawing.Rectangle structure that specifies the endpoints of the linear gradient. The starting point is the upper-left corner of the rectangle, and the endpoint is the upper-right corner of the rectangle. + A System.Drawing.Color object that represents the starting color for the gradient. + A System.Drawing.Color object that represents the ending color for the gradient. + A System.Drawing.Drawing2D.LinearGradientMode enumeration value specifying the gradient orientation. + A System.Drawing.Brush descendant representing the requested linear gradient brush (typically a System.Drawing.Drawing2D.LinearGradientBrush object). + + + + Returns a pen with specified settings. + + A System.Drawing.Color object specifying the pen color. + An integer value specifying the pen width. + A System.Drawing.Pen object representing the requested pen. + + + + Returns the pixel-wide pen with a specified color. + + A System.Drawing.Color object specifying the pen color. + A System.Drawing.Pen object representing the requested pen. + + + + Gets a solid brush with specified parameters. + + A System.Drawing.Color object specifying the brush color. + A System.Drawing.Brush descendant representing the requested brush (typically a System.Drawing.SolidBrush object). + + + + Returns a copy of the geometric world transformation for the contained object. + + A copy of the that represents the geometric world transformation for the contained object. + + + + Returns the GraphicsCache.TransformMatrix property value. + + The Matrix that is the geometric world transformation for this GraphicsCache object. + + + + Gets an object that serves as the painting surface and provides painting facilities. + + A object providing painting facilities. + + + + Gets or sets the interpolation mode associated with the cached GraphicsCache.Graphics. + + One of the values. + + + + Returns whether the region which is bounded by the specified rectangle needs to be redrawn. + + A structure that specifies the rectangle to test. + true if the specified rectangle needs to be redrawn; otherwise, false. + + + + Returns whether the region which is bounded by the specified rectangle needs to be redrawn, taking into account clip regions, if any. + + A structure that specifies the rectangle to test. + true if the specified rectangle needs to be redrawn; otherwise, false. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure. + + + + Gets or sets a DevExpress.Utils.Paint.XPaint object. + + A DevExpress.Utils.Paint.XPaint object. + + + + Gets an object providing information for painting. + + A DevExpress.Utils.Drawing.DXPaintEventArgs object that contains data used to perform painting. + + + + Gets or set a value specifying how pixels are offset during rendering of the cached GraphicsCache.Graphics. + + One of the values. + + + + Retrieves clip regions from a display device context. + + + + + Resets a Matrix object used to perform geometric transformations. + + + + + Resets the world transformation matrix of this Graphics to the identity matrix. See the method description for more details. + + + + + Restores the GraphicsCache to the required state. See the method description for more information. + + The state to restore this GraphicsCache to. + + + + Applies the specified rotation to the transformation matrix of this GraphicsCache in the specified order. + + The rotation angle. + A value that specifies whether to append or prepend the rotation matrix. + + + + Saves the current state of this GraphicsCache object. + + Stores the current GraphicsCache state. + + + + Gets or sets the ScaleHelper object that adjusts font sizes and drawing API values according to the current DPI. + + The ScaleHelper object that adjusts font sizes and drawing API values according to the current DPI. + + + + This member supports the internal infrastructure and is not intended to be used directly from code. + + + + + + Applies the scaling operation to the transformation matrix of this GraphicsCache object. See the method for more information. + + The scale factor in the X direction. + The scale factor in the Y direction. + Specifies whether the scaling operation is prepended or appended to the transformation matrix. + + + + Copies the skin information from the LookAndFeel parameter into the object. + + The object that contains the skin to be saved. + + + + Specifies the active skin and palette. + + The name of a current skin. + The name of a current skin palette. + + + + Sets the specified matrix as the transformation matrix for this GraphicsCache. + + A DevExpress.Utils.Drawing.IDxMatrix object that should be used by this GraphicsCache as the transformation matrix. + + + + Sets the specified matrix as the transformation matrix for this GraphicsCache. + + A matrix that should be used by this GraphicsCache as the transformation matrix. + + + + Gets or sets the rendering quality for the cached GraphicsCache.Graphics. + + One of the values. + + + + Gets or sets the rendering mode for text associated with the cached GraphicsCache.Graphics. + + One of the values. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A object. + + + + Applies the translation to the transformation matrix to change the origin of the coordinate system. See the method description for more information. + + The X-coordinate of the translation. + The y-coordinate of the translation. + Specifies whether the translation is prepended or appended to the transformation matrix. + + + + Returns whether or not the application currently uses the DirectX Hardware Acceleration. + + true if the application currently uses the DirectX Hardware Acceleration; otherwise, false. + + + + Contains values that specify how users can activate hyperlinks embedded in control headers. + + + + + A hyperlink is activated on a mouse click. + + + + + A hyperlink is activated on a mouse click when the CTRL key is pressed down. + + + + + The same as the None option. + + + + + Do not activate a hyperlink on a mouse pointer hover or click event. + + + + + Specifies how an image can be aligned within another object. + + + + + An image is vertically aligned at the bottom, and horizontally aligned at the center. + + + + + An image is vertically aligned at the bottom, and horizontally aligned on the left. + + + + + An image is vertically aligned at the bottom, and horizontally aligned on the right. + + + + + The default layout. + + + + + An image is horizontally and vertically aligned at the center. + + + + + An image is vertically aligned at the center, and horizontally aligned on the left. + + + + + An image is vertically aligned at the center, and horizontally aligned on the right. + + + + + An image is displayed as is, if its actual size is smaller than the size of the container. If the image size is larger than the container’s size, the image is shrunk proportionally to fit the container’s bounds. + + + + + An image is stretched to fill the available client area. + + + + + An image is stretched horizontally. + + + + + An image is stretched vertically. + + + + + An image is vertically aligned at the top, and horizontally aligned at the center. + + + + + An image is vertically aligned at the top, and horizontally aligned on the left. + + + + + An image is vertically aligned at the top, and horizontally aligned on the right. + + + + + Zooms an image proportionally so that it’s displayed within the client area in its entirety. + + + + + Zooms an image proportionally, making its smaller side (width or height) to be displayed entirely. The image is centered, so the larger side (height or width) will not be displayed in its entirety. + + + + + Contains values that specify how progress is indicated on progress bar controls. + + + + + A control repeatedly scrolls the block from one edge to another. + + + + + The same, as the ProgressAnimationMode.Cycle option. + + + + + A control scrolls the block from one edge to another, by moving the block back when it reaches any control’s edge. + + + + + Provides appearance and behavior settings for stub glyphs. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether or not items that have no images should display stub glyphs. + + A enumerator value that specifies whether or not items that have no images should display stub glyphs. +The DefaultBoolean.Default value is equal to DefaultBoolean.False. + + + + Copies all settings of the target object to this object. + + A target object whose settings are to be copied. + + + + Gets or sets the case mode for stub glyph captions. + + A DevExpress.Utils.Drawing.GlyphTextCaseMode enumerator value that specifies the case mode for stub glyph captions. + + + + Occurs whenever the object changes. + + + + + Gets or sets the stub glyphs’ color scheme. + + A DevExpress.Utils.Drawing.GlyphColorMode enumerator value that specifies the stub glyphs’ color scheme. + + + + Gets or sets the corner radius for rectangular stub glyphs. + + An Int32 value that is the corner radius for rectangular stub glyphs. + + + + Provides access to the default stub glyph caption font. + + A Font object applied to stub glyph captions by default. + + + + Gets or sets the font that should be applied to stub glyph captions. + + A Font object that should be applied to stub glyph captions. + + + + Gets or sets the horizontal alignment of stub glyphs’ captions. + + A enumerator value that specifies the horizontal alignment of stub glyphs’ captions. + + + + Gets or sets the number of initial letters of a bar item caption that should be displayed by this item’s stub glyph. + + A DevExpress.Utils.Drawing.GlyphTextSymbolCount enumerator value that allows you to choose between one and two characters. + + + + Gets or sets the distance between glyph borders and inner text content. + + A Padding structure that is the distance between glyph borders and inner text content. + + + + Gets or sets whether or not different hues of the same color are allowed. + + true, to allow different hues of the same color; otherwise, false. + + + + Tests whether or not the should be persisted. + + + + + Gets or sets the stub glyph shape. + + A DevExpress.Utils.Drawing.GlyphBackgroundType enumerator value that specifies the stub glyph shape. + + + + Gets or sets whether font settings stored in the StubGlyphOptions.Font section should be applied to stub glyphs’ captions. + + true if font settings stored in the StubGlyphOptions.Font section should be applied to stub glyphs’ captions; otherwise, false. + + + + Gets or sets the vertical alignment of stub glyphs’ captions. + + A enumerator value that specifies the vertical alignment of stub glyphs’ captions. + + + + Provides data for mouse events. + + + + + Initializes a new instance of the class. + + A enumeration value that defines which mouse button was pressed. This value is assigned to the property. + An integer value which specifies the number of times the mouse button was pressed and released. This value is assigned to the property. + An integer value which specifies the x-coordinate of a mouse click, in pixels. This value is assigned to the property. + An integer value which specifies the y-coordinate of a mouse click, in pixels. This value is assigned to the property. + An integer value which specifies a signed count of the number of detents the mouse wheel has rotated. This value is assigned to the property. + true if the event hasn’t been handled by a control; otherwise, false. This value is assigned to the DXMouseEventArgs.Handled property. + + + + Initializes a new instance of the class with the specified parameters. + + A enumeration value that defines which mouse button was pressed. This value is assigned to the property. + An integer value which specifies the number of times the mouse button was pressed and released. This value is assigned to the property. + An integer value which specifies the x-coordinate of a mouse click, in pixels. This value is assigned to the property. + An integer value which specifies the y-coordinate of a mouse click, in pixels. This value is assigned to the property. + An integer value which specifies a signed count of the number of detents the mouse wheel has rotated. This value is assigned to the property. + + + + Converts the object passed as a parameter to a object. + + A descendant. + A object which contains data for the mouse events. + A object which provides data for the mouse events. + + + + Converts the object passed as a parameter to a object. + + A object which contains data for the MouseUp, MouseDown, and MouseMove events. + A object which provides data for the mouse events. + + + + Gets or sets a value specifying whether an event has been handled. + + true if the event hasn’t been handled by a control; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether these event arguments provide data for the MouseUp, MouseDown, and MouseMove events. + + true if this object is of the MouseEventArgs type; otherwise, false. + + + + For internal use. + + + + + Enumerates values that specify whether a cell editor is activated when the left mouse button is pressed or released, and whether the cell should be focused to activate the editor. + + + + + A cell editor is activated when the left mouse button is released in a focused cell. + + + + + The mode is not specified explicitly. The actual mode depends on the control and its settings. See remarks in the following topic for more information: EditorShowMode Enum. + + + + + A cell editor is activated when the left mouse button is pressed regardless of whether the cell is focused. + + + + + A cell editor is activated when the left mouse button is pressed in a focused cell. + + + + + A cell editor is activated when the left mouse button is released regardless of whether the cell is focused. + + + + + Contains classes used to create a filtering UI. + + + + + Generates a filtering UI for a data-aware control (Data Grid, Tree List, Chart Control, etc.) or Data Model. + + + + + The floating panel that is displayed and hidden using an animation effect. See Flyout Panel. + + + + + Initializes a new instance of the class. + + + + + This property is not supported by the class. + + + + + Gets or sets the speed of the animation used to show and hide the . + + An integer value specifying the rate of the animation used to show and hide the . + + + + Fires when the panel is about to hide. Allows you to enable the e.Cancel parameter to keep this panel visible. + + + + + Fires immediately prior to the panel showing up. Allows you to enable the e.Cancel parameter to prevent this panel from being displayed. + + + + + Fires when a check button within the button panel of this is checked. + + + + + Occurs when a button in the ‘s built-in button panel is clicked. + + + + + Fires when a check button within the button panel of this is unchecked. + + + + + This property is not supported by the class. + Use the FlyoutPanelOptions.AnchorType property to specify the position at which the panel is displayed. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns a color for the glyph skinning feature. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A BaseButtonInfo object. + A System.Drawing.Color structure. + + + + Fires after the panel has been hidden. + + + + + This method is not supported by the class. Use the FlyoutPanel.HidePopup method instead. + + + + + Hides the current displayed as a beak form using an animation effect specified by the OptionsBeakForm.AnimationType property. + + + + + Hides the current displayed as a beak form immediately or using an animation effect specified by the OptionsBeakForm.AnimationType property. + + true if the beak form should be hidden immediately; otherwise, false. + + + + Hides the using an animation effect specified by the FlyoutPanelOptions.AnimationType property. + + + + + Hides the immediately or using an animation effect specified by the FlyoutPanelOptions.AnimationType property. + + true, to hide the panel immediately; false to hide the panel using an animation effect. + + + + Fires when a panel is about to be hidden. + + + + + Gets whether the current is displayed. + + true if the current is displayed; otherwise, false. + + + + Gets or sets the minimum size of the . + + A object that specifies the minimum size of the . + + + + Contains the FlyoutPanel’s view and behavior options. + + The FlyoutPanel’s view and behavior options. + + + + Provides access to the settings applied to the current displayed as a beak form. + + A BeakPanelOptions object representing the settings applied to the current displayed as a beak form. + + + + Provides access to the set of options applied to the built-in button panel. + + A object representing a set of options applied to the built-in button panel. + + + + Gets or sets the FlyoutPanel’s owner, relative to which the panel is displayed. + + The FlyoutPanel’s owner, relative to which the panel is displayed. + + + + Gets or sets the form that owns this . + + A Form that owns this . + + + + This method is not supported by the class. Use the FlyoutPanel.ShowPopup method instead. + + + + + Displays the current as a beak form using an animation effect specified by the OptionsBeakForm.AnimationType property. + + + + + Displays the current as a beak form immediately or using an animation effect specified by the OptionsBeakForm.AnimationType property. + + true if the beak form should be displayed immediately; otherwise, false. + + + + Displays the current as a beak form at the specified position with the specified offset using an animation effect specified by the OptionsBeakForm.AnimationType property or immediately. + + A System.Drawing.Point structure that specifies the location on the screen where the beak form should be displayed. + true if the beak form should be displayed immediately; otherwise, false. + A Control that owns the current . + A System.Drawing.Point structure by which the location specified with the loc parameter should be translated. + An IFlyoutPanelPopupController implementation that specifies the beak form behavior. For instance, whether to automatically close the opened beak form on a mouse move depending on the mouse coordinates relative to the form location. + + + + Displays the current as a beak form at the specified position with the specified offset using an animation effect specified by the OptionsBeakForm.AnimationType property or immediately. + + A System.Drawing.Point structure that specifies the location on the screen where the beak form should be displayed. + true if the beak form should be displayed immediately; otherwise, false. + A Control that owns the current . + A System.Drawing.Point structure by which the location specified with the loc parameter should be translated. + + + + Displays the current as a beak form at the specified position using an animation effect specified by the OptionsBeakForm.AnimationType property or immediately. + + A System.Drawing.Point object that specifies the location on the screen where the beak form should be displayed. + true if the beak form should be displayed immediately; otherwise, false. + A Control that owns the current . + + + + Displays the current as a beak form at the specified position using an animation effect specified by the OptionsBeakForm.AnimationType property or immediately. + + A System.Drawing.Point object that specifies the location on the screen where the beak form should be displayed. + true if the beak form should be displayed immediately; otherwise, false. + + + + Displays the current as a beak form at the specified position using an animation effect specified by the OptionsBeakForm.AnimationType property. + + A System.Drawing.Point object that specifies the location on the screen where the beak form should be displayed. + + + + Displays the current as a beak form relative to the specified rectangle with the specified offset using an animation effect specified by the OptionsBeakForm.AnimationType property or immediately. + + A structure that specifies an area on the screen relative to which a beak form should be displayed. + A object that specifies the location on the screen where a beak form should be displayed if the rect parameter is Rectangle.Empty. + true if the beak form should be displayed immediately; otherwise, false. + A Control that owns the current . + A System.Drawing.Point structure by which the location specified with the loc parameter should be translated. + An IFlyoutPanelPopupController implementation that specifies the beak form behavior. For instance, whether to automatically close the opened beak form on a mouse move depending on the mouse coordinates relative to the form location. + + + + Displays the current as a beak form relative to the specified rectangle using an animation effect specified by the OptionsBeakForm.AnimationType property. + + A structure that specifies an area on the screen relative to which a beak form should be displayed. + A object that specifies the location on the screen where a beak form should be displayed if the rect parameter is Rectangle.Empty. + + + + Displays the current as a beak form relative to the specified rectangle using an animation effect specified by the OptionsBeakForm.AnimationType property. + + A structure that specifies an area on the screen relative to which a beak form should be displayed. + + + + Fires when the panel is about to be displayed. + + + + + Fires after the panel has been displayed. + + + + + Displays the panel at the position specified by the FlyoutPanelOptions.AnchorType property using an animation effect specified by the FlyoutPanelOptions.AnimationType property. + + + + + Displays the panel at the position specified by the FlyoutPanelOptions.AnchorType property immediately or using an animation effect specified by the FlyoutPanelOptions.AnimationType property. + + true if the panel is displayed immediately (without an animation); otherwise, false. + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of tooltips displayed by buttons in the button panel. + + A object which controls the appearance and behavior of tooltips displayed by buttons in the button panel. + + + + This property is not supported by the class. Use the FlyoutPanel.ShowPopup and FlyoutPanel.HidePopup methods to control the panel visibility. + + + + + Contains miscellaneous settings applied to a ‘s built-in button panel. + + + + + Initializes a new instance of the class with the specified settings. + + A that owns the current . + + + + Gets or sets whether button glyphs are painted based on the ‘s foreground color. + + true if button glyphs are painted based on the ‘s foreground color; otherwise, false. + + + + Provides access to appearance settings used to paint the ‘s buttons in different visual states. + + A DevExpress.XtraEditors.ButtonsPanelControl.ButtonsPanelControlAppearance object that stores appearance settings. + + + + Gets or sets the alignment of buttons within the button panel. + + A System.Drawing.ContentAlignment enumeration value that specifies the alignment of buttons within the button panel. + + + + Gets or sets the built-in button panel’s height. + + A value specifying the button panel’s height, in pixels. + + + + Gets or sets the location of the built-in button panel in the . + + A FlyoutPanelButtonPanelLocation enumeration value specifying the location of the built-in button panel in the . + + + + Provides access to the collection of buttons displayed in the ‘s built-in button panel. + + A BaseButtonCollection object representing a button collection. + + + + Gets or sets the source of images that can be displayed within buttons. + + A that is an image collection providing images for buttons. + + + + Gets or sets the amount of space around the button panel. + + A System.Windows.Forms.Padding structure that specifies the amount of space around the button panel. + + + + Resets settings applied to the built-in button panel to the default values. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Gets or sets whether the built-in button panel is displayed in the . + + true if the built-in button panel is displayed; otherwise, false. + + + + Contains view and behavior options for a . + + + + + Initializes a new instance of the class. + + + + + Gets or sets the position at which the is displayed relative to its owner (FlyoutPanel.OwnerControl). + + The position at which the FlyoutPanel is displayed relative to its owner. + + + + Gets or sets the animation effect used to display and hide the . + + The animation effect used to display and hide the FlyoutPanel. + + + + Gets or sets whether the is automatically closed when the owner control is hidden. + + true if the is automatically closed when the owner control is hidden; otherwise, false. + + + + Gets or sets whether the is hidden on clicking outside the panel’s bounds. + + true if the is hidden on clicking outside the panel’s bounds; otherwise, false. + + + + The default value for the FlyoutPanelOptions.AnchorType property. + + + + + The default value for the FlyoutPanelOptions.AnimationType property. + + + + + The default value for the FlyoutPanelOptions.CloseOnHidingOwner property. + + + + + The default value for the FlyoutPanelOptions.CloseOnOuterClick property. + + + + + The default value for the FlyoutPanelOptions.HorzIndent property. + + + + + The default value for the FlyoutPanelOptions.Location property. + + + + + The default value for the FlyoutPanelOptions.VertIndent property. + + + + + Gets or sets the panel’s horizontal indent from the owner’s top left or top right corner when the FlyoutPanelOptions.AnchorType property is set to TopLeft or TopRight. + + The panel’s horizontal indent from a corner, in pixels. + + + + Gets or sets the display position of the when the FlyoutPanelOptions.AnchorType property is set to Manual. The position is relative to the owner’s top left corner. + + The display position of the FlyoutPanel when the AnchorType property is set to Manual, in pixels. + + + + Gets or sets the panel’s vertical indent from the owner’s top left or top right corner when the FlyoutPanelOptions.AnchorType property is set to TopLeft or TopRight. + + The panel’s vertical indent from a corner, in pixels. + + + + Contains values that specify how an element is displayed relative to a text label within a group control. + + + + + Displays an element after a text label. + + + + + Displays an element before a text label. + + + + + Specifies the default position of an element relative to a text label. + Currently, the Default option is equivalent to the BeforeText option. + + + + + Prevents default actions when handling specific events. This class supports internal infrastructure and is not intended for use in code. + + + + + Initializes a new class instance. + + + + + Provides values that specify whether or not to underline characters that are preceded with an ampersand symbol (&) in certain controls. + + + + + Underline the character that is preceded by the ampersand symbol (&) when a user presses ALT. + + + + + Do not underline the character that is preceded by the ampersand symbol (&). + + + + + + Show the ampersand symbol (&). + + + + + + Underline the character preceded by the ampersand symbol (&). + + + + + + Exposes classes that allow you to create HTML & CSS templates. + + + + + Stores information about a region where an instance of an HTML template should be painted. You need to manually create and set up DxHtmlPainterArgs objects only when you paint templates on top of non-DevExpress controls, or DevExpress controls that currently do not support custom-drawn templates. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the object that stores appearance-related settings of the parent control. + + Stores appearance-related settings of the parent control. + + + + Gets or sets the bounds of a region where an HTML template can be drawn. + + Specifies bounds of a region where an HTML template can be drawn. + + + + Gets or sets the object that exposes DirectX-compatible drawing methods and stores brushes and pens. + + Stores pens and brushes, and allows you to call drawing methods. + + + + Gets or sets the collection of images that can be assigned to HTML elements. + + Stores images that can be assigned to HTML elements. + + + + Gets or sets the key that identifies this currently painted HTML template instance. You can later check keys to obtain a correct template instance (for example, when you need to pass control mouse events to a template). + + The unique key assigned to the HTML template instance. + + + + Gets or sets the object that stores look-and-feel settings of the parent control. + + Stores look-and-feel settings of the parent control. + + + + Allows you to assign the required data portion to the target HTML element. + + The name of a data field to which the HTML element is bound. + Data assigned to the HTML element. + + + + This is an internal property that should not be used in your code. + + + + + + Allows you to transfer mouse events from a control to an instance of an HTML template painted on top of this control. + + + + + Initializes a new instance of the class. + + + + + Returns the hit information about an HTML element located at the given coordinates. + + The coordinates of a point to check. The (0,0) coordinates belong to the top left corner of a template. + The ID that allows you to obtain the specific instance of a custom-drawn template. + Contains hit information related to the element that is located underneath the target point. + + + + Returns the cursor assigned to this HTML element in a CSS stylesheet. + + The hit information related to the target HTML element. + The cursor related to the target HTML element. + + + + Finds an HTML element located at the given coordinates, and retrieves a cursor associated with this element. + + The coordinates of a template instance to check. + The ID that allows you to identify the required instance of a custom-drawn template. + The cursor associated with this element. + + + + Transfers the MouseLeave mouse event to the target HTML element. This allows the element to change its visual state from “hovered” to “normal”. + + The EventArgs object utilized by the origin MouseLeave event (the MouseLeave event of the parent control). + The ID that allows you to identify the specific instance of a custom-drawn template. + + + + Transfers the MouseMove mouse event to the target HTML element. This allows the element to change its visual state from “normal” to “hovered”. + + The EventArgs object utilized by the origin MouseMove event (the MouseMove event of the parent control). + The ID that allows you to identify the specific instance of a custom-drawn template. + + + + An HTML-CSS template used to render a UI of DevExpress controls. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with settings from the source HtmlTemplate object. + + The object whose settings are used to initialize the newly created object. + + + + Initializes a new instance of the class with specified settings. + + The HTML markup used to initialize the HtmlTemplate.Template property. + The CSS code used to initialize the HtmlTemplate.Styles property. + + + + Copies settings of the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Returns a copy of the current object. + + A copy of the current object. + + + + Returns whether the HtmlTemplate.Template and HtmlTemplate.Styles properties are set to empty values. + + true if the current object has empty HtmlTemplate.Template and HtmlTemplate.Styles property values; otherwise, false. + + + + The object’s name. + + The object’s name. + + + + Fires when the HtmlTemplate.Template or HtmlTemplate.Styles property is changed. + + + + + Assigns the specified HTML-CSS template to the current object. + + The HTML markup to assign to the HtmlTemplate.Template property. + The CSS code to assign to the HtmlTemplate.Styles property. + + + + This member supports the internal infrastructure, and is not intended to be used directly in your code. + + + + + + Gets or sets the template’s CSS code that specifies the appearance settings, size, padding, and layout options of UI elements. + + The template’s CSS code. + + + + Gets or sets an object that stores custom data. + + An object that stores custom data. + + + + Gets or sets the template’s HTML markup used to build a control’s UI. + + The template in HTML markup. + + + + The collection of HTML templates that can be used as an external template storage by other controls. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The list of templates that should be stored inside this newly created collection. + + + + Adds an array of HTML templates to this collection. + + The array of templates to add. + + + + Initializes a new HTML template and places it into this collection. + + A string that stores the entire HTML markup of a newly created template. + A string that stores the stylesheet (CSS styles) for the newly created template. + The new template created with the given markup and stylesheet strings. + + + + Copies all settings from the target HtmlTemplateCollection to this HtmlTemplateCollection. + + The source HtmlTemplateCollection whose settings should be copied. + + + + Occurs when this HtmlTemplateCollection was modified (for example, a new template was added to this collection). + + + + + Copies this HtmlTemplateCollection. + + The copy of this HtmlTemplateCollection. + + + + The parent container of this collection. + + The parent of this collection. + + + + Returns the total number of HTML templates stored by this HtmlTemplateCollection. + + The number of child HtmlTemplateCollection templates. + + + + Disposes of this HtmlTemplateCollection and releases all resources used by it. + + + + + Occurs when this HtmlTemplateCollection is disposed of. + + + + + Allows you to access templates stored inside this HtmlTemplateCollection. + + The list of templates stored by this collection. + + + + Gets or sets an for the object. + + The for the object. + + + + Provides data for events that occur when users click a hyperlink. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Get or sets the URL of the clicked hyperlink. + + The hyperlink value. + + + + Gets or sets mouse coordinates calculated from the toolbar’s upper left corner. + + Mouse coordinates of the clicked link. + + + + Gets or sets the hyperlink alt text. Note that modifying this text does not change the item caption. + + The hyperlink alt text. + + + + The collection of objects to be used within DevExpress controls. + The ImageCollection is also used as a part of the component. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + true to permit image modification; otherwise, false. + + + + Initializes a new instance of the class with the specified container. + + An object that implements the interface. + + + + Adds an image with the specified name to the collection. + + An Image to be added to the collection. + A string that specifies the image’s name. You can then retrieve images by name via the ImageCollection.Images property. + + + + Appends the specified image to the collection. + + The image to add to the collection. + + + + Appends the specified image to the specified list. + + An object that represents the collection of images. + The image to add to the specified collection. + + + + Adds the images from the specified horizontal image strip to the collection. + + The image(s) to add to the collection. + + + + Adds the images from the specified vertical image strip to the collection. + + The image(s) to add to the collection. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Notifies the image collection that initialization is starting. + + + + + Fires after the image collection has been changed. + + + + + Removes all images from the collection. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Draws the image. + + A object that provides storage for pens, fonts and brushes used when painting. + The to draw. + An object that represents the image source. This parameter is in effect if the image parameter is null. + An integer value that identifies the image within the collection. This parameter is in effect if the image parameter is null. + A structure that specifies the bounding rectangle of the image. + true, to draw an image in enabled state; otherwise, false. + + + + Draws the image using the specified paint settings. + + The object that allows you to paint shapes and lines, and stores recently used pens, fonts, and brushes. + The Image to draw. + The source of images. This parameter is in effect if the image parameter is null. + Identifies the image within the images collection. This parameter is in effect if the image parameter is null. + The drawing area. + The color-adjustment matrix that contains coordinates for the RGBAW space. + + + + Draws the specified image using the specified paint settings. + + Provides the paint surface and storage of the recently used pens, fonts and brushes. + The to draw. + An object that represents the source of images. This parameter is in effect if the image parameter is null. + An integer value that identifies the image within the collection. This parameter is in effect if the image parameter is null. + A structure that specifies the drawing area. + Contains information about how image colors are manipulated during rendering. + + + + Draws the specified image using the specified paint settings. + + A object that provides storage for pens, fonts and brushes used when painting. + An object that represents the image source. + An integer value that identifies the image within the collection. + A structure that specifies the bounding rectangle of the image. + An ISvgPaletteProvider object specifying colors used to paint vector images. + + + + Draws the specified image using the specified paint settings. + + A object that provides storage for pens, fonts and brushes used when painting. + An object that represents the image source. + An integer value that identifies the image within the collection. + A structure that specifies the bounding rectangle of the image. + true, to draw an image in enabled state; otherwise, false. + An ISvgPaletteProvider object specifying colors used to paint vector images. + + + + Draws the image. + + A object that provides storage for pens, fonts and brushes used when painting. + An object that represents the image source. + An integer value that identifies the image within the collection. + A structure that specifies the bounding rectangle of the image. + true to draw an image in enabled state; otherwise, false. + + + + Draws the image using the specified paint settings. + + The object that allows you to paint shapes and lines, and stores recently used pens, fonts, and brushes. + The source of images. + Identifies the image from the images collection that should be painted. + The drawing area. + The color-adjustment matrix that contains coordinates for the RGBAW space. + Specifies colors used to paint vector images. + + + + Draws the image using the specified paint settings. + + The object that allows you to paint shapes and lines, and stores recently used pens, fonts, and brushes. + The source of images. + Identifies the image from the images collection that should be painted. + The drawing area. + The color-adjustment matrix that contains coordinates for the RGBAW space. + + + + Draws the specified image using the specified paint settings. + + Provides the paint surface and storage of the recently used pens, fonts and brushes. + An object that represents the image source. + An integer value that identifies the image within the collection. + A structure that specifies the bounding rectangle of the image. + Contains information about how image colors are manipulated during rendering. + An ISvgPaletteProvider object specifying colors used to paint vector images. + + + + Draws the specified image using the specified paint settings. + + Provides the paint surface and storage of the recently used pens, fonts and brushes. + An object that represents the source of images. + An integer value that identifies the image within the collection. + A structure that specifies the drawing area. + Contains information about how image colors are manipulated during rendering. + + + + Draws the specified image at the specified location. + + A object that specifies the storage for the most used pens, fonts and brushes. + An object that represents the source of the images. + A zero-based integer that specifies the index of the image within the images. + A structure that specifies the drawing area. + + + + Draws the specified image in the specified state and at the specified location. + + A DevExpress.Utils.Drawing.GraphicsInfoArgs object. + An object that represents the source of the images. + A zero-based integer that specifies the index of the image within the images. + A structure that specifies the drawing area. + true to draw the image in the enabled state; otherwise, false. + + + + Notifies the image collection that initialization is complete. + + + + + Saves the contents of the current collection to a file. + + A string that specifies the name of the file to which the contents of the image collection is saved. + + + + Returns the image at the specified position in the target image list. + + An object that represents the source of images. + A zero-based integer that specifies the index of the image in the images. + An ISvgPaletteProvider object that specifies colors used to paint vector images. + A vector image size. + An integer value that specifies the scale factor. + A SvgImageColorizationMode enumeration value that specifies whether the image should be colorized with default colorization engine settings. + An descendant that represents the image at the specified position within the specified image list. null (Nothing in Visual Basic) if the image isn’t found. + + + + Returns the image at the specified position in the specified image list. + + An object that represents the source of images. + A zero-based integer that specifies the index of the image in the images. + An integer value that specifies the scale factor. + An descendant that represents the image at the specified position within the specified image list. null (Nothing in Visual Basic) if the image isn’t found. + + + + Returns the image with the specified key in the specified image list. + + An object that represents the source of images. + A string value that is the key of the image to be returned. + An integer value that specifies the scale factor. + An descendant that represents the image at the specified position within the specified image list. null (Nothing in Visual Basic) if the image isn’t found. + + + + Returns the number of images within the specified source of images. + + An object that represents the source of images. + An integer value that specifies the number of images within the specified image source. + + + + Returns the size of the image at the specified position in the image list. + + An object that represents the source of images. + The index of the required image in the images list. + An integer value that specifies a custom scale factor. + A structure that specifies the size of a specific image. + + + + Returns the size of the specified image or of an image in the image list addressed by a specific index. + + An image whose size is returned. + An object that represents the source of images. This parameter is in effect if the image parameter is set to null. + The index of the required image in the images list. + A value that specifies the size of a specific image. + + + + Returns the size of the images in the specified image list. + + An object that represents the source of the images. + An integer value that specifies a custom scale factor. + A structure that specifies the height and width of the images in the specified list. + + + + When the ImageCollection.IsDpiAware option is enabled, the GetImageSize event allows you to customize the size of images returned by the . This event is fired on finishing an object initialization. + + + + + Returns the image stored in the specified file. + + A string that specifies the full path to the file. + A object that represents the image stored in the specified file; null if the image cannot be loaded. + + + + Provides access to the collection of images. + + A object that represents the collection of images. + + + + Gets or sets the size of images in the image collection. + For the , this property specifies the size of images fetched from an image strip (at design time or via the ImageCollection.AddImageStrip and ImageCollection.AddImageStripVertical methods). + + A structure which specifies the height and width of the images in the list. + + + + Gets or sets the handle to the associated with the current image collection. + + A handle to the for the current image collection. null (Nothing in Visual Basic) if the current image collection is empty. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Inserts an image from project resources. + + An image to be inserted. + The name of the image to be inserted. + The type of the class where the image to be inserted is defined. + An integer value that specifies the position at which the image needs to be inserted in the image collection. + The name of the class where the image to be inserted is defined. + + + + Inserts an image from project resources. + + An image to be inserted. + The name of the image to be inserted. + The type of the class where the image to be inserted is defined. + An integer value that specifies the position at which the image needs to be inserted in the image collection. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the value that specifies that when requesting an image from the ImageCollection, another DPI-specific image corresponding to the requested image is returned instead. + + The DefaultBoolean.True value if a requested image is replaced with a DPI-specific image; DefaultBoolean.False or DefaultBoolean.Default if this feature is disabled. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + The . + An object that represents the image source. + An integer value that specifies the position of the image within the collection. + The Boolean value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Determines whether the image exists at the specified position within the specified source of images. + + An object that represents the source of images. + A zero-based integer that specifies the index of the image within the images. + true if the image exists at the specified position within the specified source of images; otherwise, false. + + + + Returns whether the specified collection contains DPI-specific images. + + An image collection to check for DPI-specific images. + An integer value specifying a zero-based index to check whether an image with this index exists in the specified collection. + true if the specified collection contains DPI-specific images; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns whether an image with the specified index exists in the specified collection. + + An object that represents the source of images. + The index of the required image in the images list. + true if an image exists; otherwise, false. + + + + Registers specific external image-containing assemblies within your application. + + A String array that contains names of the assemblies that should be registered. + + + + Provides access to external image-containing assemblies, registered by this . + + A DevExpress.Utils.ImageCollectionRegisteredAssemblies object that stores registered assemblies. + + + + When requesting an image from the ImageCollection, the ResolveImage event fires when the project resources do not contain a DPI-specific image that matches the requested image and allows you to provide this DPI-specific image manually. This event is in effect when the ImageCollection.IsDpiAware option is enabled and the requested image was loaded into the ImageCollection from the project resources. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the color to treat as transparent. + + The which represents the color that is not rendered when the image is drawn. + + + + A base class that provides API for the DevExpress.Utils.SvgImageCollection component. + + The type of images stored inside a descendant class (DevExpress.Utils.Svg.SvgImage in case of SvgImageCollection objects). + The type of the image info for images stored inside a descendant class (DevExpress.Utils.SvgImageInfo in case of SvgImageCollection objects). + + + + Initializes a new instance of the ImageCollection class descendant with the default settings. + + + + + Initializes a new instance of the ImageCollection class descendant with the specified settings. + + An IContainer that specifies an object that owns this image collection descendant. + + + + Adds a specific image to this collection. + + The image to add. + + + + Adds a specific image to this collection. + + The name that the added image will have in this collection. + The image to add. + + + + Adds an image from the resource assembly to this collection. + + The name that the added image will have in this collection. + The complete image name that includes the assembly name and the extension. + The assembly name. + + + + Adds a resource image to this collection. + + The name that the added image will have in this collection. + The image name as it appears in resources. + The resource class type. + + + + Adds an image to this collection by its URI. + + The name that the added image will have in this collection. + The URI of the added image. See Image Gallery and Context-Dependent Images article to learn more. + + + + Adds multiple images to this collection. + + An IEnumerable object that contains multiple images to be added. + + + + Starts the collection’s initialization. + + + + + Fires when the collection changes. + + + + + Removes all images from this collection. + + + + + Checks whether this collection contains the target image. + + The image to check. + true if the collection has this image; otherwise, false. + + + + Checks whether this collection has an image with the specific name. + + The image name to check. + true if the collection has an image with such name; otherwise, false. + + + + Copies all collection images to the specific array. + + An array to which the collection should copy its images. + An Int32 value that specifies the copied images’ starting position within the array. + + + + Returns the current number of images in this collection. + + The image number. + + + + Finalizes the collection initialization. + + + + + Returns a regular raster image of a specific size. This raster image is produced from a source vector image, and colorized according to the provided palette. Throws the if the collection has no vector image with the given index. + + An index of a source vector image within this collection. + An ISvgPaletteProvider object that specifies a palette according to which the produced raster image should be colorized. See this article to learn why and how images change their colors depending on skins and palettes: How To: Draw and Use SVG Images. + The size of the produced raster image. + The colorization mode for the source SVG image. + The raster image produced from the source SVG image. + + + + Returns a regular raster image of a specific size, scaled according to the size multiplier. This raster image is produced from a source vector image. Throws the if the collection has no vector image with the given index. + + The image index within the collection. + An ISvgPaletteProvider object that specifies a palette according to which the produced raster image should be colorized. See this article to learn why and how images change their colors depending on skins and palettes: How To: Draw and Use SVG Images. + The size multiplier. + The size the produced image has if the scaleFactor is 1. Otherwise, the image is scaled. + The colorization mode for the source SVG image. + The raster image produced from the source vector image. + + + + Returns a regular raster image of the desired size. The image is produced from a source vector image. Throws the System.ArgumentOutOfRangeException if the collection has no vector image with the given index. + + An Index of a source vector image within the collection. + The size of a produced image. + The colorization mode for the source SVG image. + The raster image produced from a vector image. + + + + Returns a regular raster image of the desired size, scaled according to the size multiplier. The image is produced from a source vector image. Throws the if the collection has no vector image with the given index. + + The index of a source vector image within this collection. + The size multiplier. + The size the produced image has if the scaleFactor is 1. Otherwise, the image is scaled. + The colorization mode for the source SVG image. + The raster image produced from the source vector image. + + + + Returns a regular raster image of a specific size. This raster image is produced from a source vector image, and colorized according to the provided palette. Returns null if the collection has no vector image with the given name. + + The image name within the collection. + An ISvgPaletteProvider object that specifies a palette according to which the produced raster image should be colorized. See this article to learn why and how images change their colors depending on skins and palettes: How To: Draw and Use SVG Images. + A Size structure that is the size of a produced image. + The colorization mode for the source SVG image. + An Image that is the raster image produced from a vector image. + + + + Returns a regular raster image of a specific size, scaled according to the size multiplier. This raster image is produced from a source vector image and colorized according to the provided palette. Returns null if the collection has no vector image with the given name. + + The vector image name within the collection. + An ISvgPaletteProvider object that specifies a palette according to which the produced raster image should be colorized. See this article to learn why and how images change their colors depending on skins and palettes: How To: Draw and Use SVG Images. + The size multiplier. + The size the produced image has if the scaleFactor is 1. Otherwise, the image is scaled. + The colorization mode for the source SVG image. + The raster image produced from a vector image. + + + + Returns a regular raster image of a specified size. The image is produced from a source vector image. Returns null if the collection has no vector image with the given name. + + The vector image name within the collection. + The size of the produced image. + The colorization mode for the source SVG image. + The raster image produced from the vector image. + + + + Returns a regular raster image of the desired size, scaled according to the size multiplier. The image is produced from a source vector image. Returns null if the collection has no vector image with the given name. + + The vector image name within the collection. + The size multiplier. + The default size of the produced image (when the scaleFactor is 1). The size is scaled if the scaleFactor is not 1. + The colorization mode for the source vector image. + The raster image produced from a source vector image. + + + + Gets or sets colorization mode for SVG images in the current collection. + + Colorization mode for SVG images in the current collection. + + + + Returns the Info objects for all images owned by this collection. + + The collection that stores info objects for every ImageCollection image. + + + + Gets or sets the default size for raster images rendered based on vector images. This setting is used if a control does not specify the size. + + The default image size. + + + + Returns the collection index of the specific image. + + The image whose index is to be obtained. + The image index inside this collection. + + + + Adds the specific image to this collection, , and places this image to the specific position. + + The position the added image should have inside this collection. + The image to be added. + + + + Adds the specific image to this collection, and places it to the specific position. + + The position the added image should have inside this collection. + The name that the added image will have in this collection. + The image to add. + + + + Adds an image from the assembly to this collection, and places this image to the specific position. + + The position the added image should have inside this collection. + The name that the added image will have in this collection. + The complete image name that includes the assembly name and the extension. + The assembly name. + + + + Adds an image from resources, and places this image to the specific position. + + The position the added image should have inside this collection. + The name that the added image will have in this collection. + The image name as it appears in resources. + The resource class type. + + + + Adds an image to this collection by its URI, and places this image to the specific position. + + The position the added image should have inside this collection. + The name that the added image will have in this collection. + The URI of the added image. See Image Gallery and Context-Dependent Images article to learn more. + + + + Returns a collection image by its index. + + The image index inside this collection. + The image that occupies the given position in this collection. + + + + Returns a collection image by its name. + + The image name. + The image that has the given name. + + + + Returns names for all images kept in this collection. + + An IEnumerable object that stores all image names. + + + + Removes the image from this collection. + + The image to remove. + true if the image was successfully removed; otherwise, false. + + + + Removes an image with the specific index from this collection. + + The index of an image to be removed. + + + + Removes an image with the specific name from this collection. + + The name of an image to be removed. + + + + Returns the actual (DPI-aware) size of images stored in this . + + A Size structure that is the actual image size. + + + + Renames the target image. + + An SvgImage that is the image to be renamed. + The new image name. + + + + Renames the target image. + + Tthe position of an image that needs to be renamed. + The new image name. + + + + Represents a collection of objects. + + + + + Initializes a new instance of the class with the specified settings. + + An object representing the object’s owner. + true to permit image modification; otherwise, false. + + + + Initializes a new instance of the class with the specified owner. + + An object that represents the image collection which owns this object. + + + + Adds an image with the specified name to the collection. + + An image to add to the collection. + A string that specifies the name of the image, + An integer value that specifies the position at which the image has been added. + + + + Appends the specified image to the current collection of images. + + A object to append to the collection. + An integer value indicating the position at which the new element was inserted. -1 if the specified image is null (Nothing in Visual Basic) or empty. + + + + Adds images from the specified horizontal image strip to the collection. + + The image(s) to add to the collection. + + + + Adds images from the specified vertical image strip to the collection. + + The image(s) to add to the collection. + + + + Adds images from the specified list to the current collection. + + A IList object that contains images to be added to the collection. + + + + Adds an array of images to the current collection. + + An array of images to be added to the collection. + + + + Clears the current collection. + + + + + Gets whether the collection contains the specified element. + + An object to locate in the collection. + A Boolean value that specifies whether the collection contains the specified element. + + + + Copies the collection to a compatible one-dimensional Array, starting at the specified index of the target array. + + The one-dimensional Array that is the destination of the elements copied from the collection. The Array must have zero-based indexing. + The zero-based index in the array in which copying begins. + + + + Gets the number of items in the collection. + + An integer value that specifies the number of items in the collection. + + + + Returns an enumerator for the collection. + + An IEnumerator for the collection. + + + + Returns an image from the image collection at the specified position within the specified height and width. + + A object which resolution settings will be applied to the resulting image. + An integer value that specifies the width of the resulting image. + An integer value that specifies the height of the resulting image. + An integer value that specifies the vertical position of the resulting image in the images collection. + An integer value that specifies the horizontal position of the resulting image in the images collection. + A object which represents an image at the specified position of the specified size. + + + + Searches for the specified Object and returns the zero-based index of the first occurrence within the collection. + + The zero-based index of the first occurrence of value within the collection, if found; otherwise, -1. + The Object to locate in the collection. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + An InnerImagesList object. + + + + Inserts an image from project resources. + + An image to be inserted. + The name of the image to be inserted. + The type of the class where the image to be inserted is defined. + An integer value that specifies the position at which the image needs to be inserted in the image collection. + The name of the class where the image to be inserted is defined. + An integer value that specifies the index of the inserted image in the image collection. + + + + Inserts an image from project resources. + + An image to be inserted. + The name of the image to be inserted. + The type of the class where the image to be inserted is defined. + An integer value that specifies the position at which the image needs to be inserted in the image collection. + An integer value that specifies the index of the inserted image in the image collection. + + + + Inserts an image with the assigned name into the collection at the specified position. + + An integer value specifying the zero-based position at which the specified image is inserted. + An image to insert into the collection. + A string that specifies the name to be associated with the image. + + + + Inserts an image into the collection at the specified position. + + An integer value specifying the zero-based position at which the specified image is inserted. + An image to insert into the collection. + + + + Inserts an image from the target assembly. + + A String value that is the name of the source assembly that stores the required image. + A String value that is the image name. + A String value that is the path to the source assembly. + An Int32 value that is the position within the collection at which the target image should be placed. + An Int32 value that is the index of the successfully inserted image. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets a value indicating whether the collection has a fixed size. + + false. + + + + Gets a value indicating whether the collection is read-only. + + false. + + + + Gets a value indicating whether access to the collection is synchronized (thread safe). + + true. + + + + Provides indexed access to individual items in the collection. + + A zero-based integer specifying the desired item’s position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + A object which represents the image at the specified position. + + + + Provides access to the images in the collection by their names. + + A string that specifies the name of the image to locate in the collection. + An image with the specified name. + + + + Gets the collection of names assigned to the images in the current collection. + + A StringCollection of names assigned to the images in the current collection. + + + + Removes the specified image from the collection. + + An image to remove from the collection. + + + + Removes an image at the specified position from the collection. + + A zero-based index of the required image. + + + + Removes an image with the specified name from the collection. + + A string that specifies the name of the required image. + + + + Assigns a name to the image located at the specified position within the collection. + + An integer value that specifies the zero-based index of the required image. + A string that specifies the name to be assigned to the image. + + + + Gets an object that can be used to synchronize access to the collection. + + The current object. + + + + Copies the elements of the to a new array of objects. + + An array of objects containing the copies of the elements of the . + + + + A class used by various controls to provide shortcut keys. + + + + + Creates an instance of the class and sets the shortcut to the value. + + + + + Creates an instance of the class with the specified shortcut. + + The key combination to initialize the KeyShortcut.Key property. Values of the type can be combined using the OR operator. + + + + Creates an instance of the class with the specified shortcut. + + The key combination to initialize the KeyShortcut.Key property. + + + + Gets the name of the ALT key which is dependent upon the end-user’s regional settings. + + A string which specifies the name of the ALT key. + + + + Gets the name of the CONTROL key which is dependent upon the end-user’s regional settings. + + A string which specifies the name of the CONTROL key. + + + + Gets the static object whose KeyShortcut.Key property is set to . + + + + + Tests whether the shortcuts of the current and specified objects are identical. + + The object representing the object. + true if the function parameter represents a object and its shortcut is equal to the shortcut of the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + Returns the text representation of the specified System.Windows.Forms.Keys object. + + The object whose text representation is to be obtained. + The text representation of the specified Keys object. + + + + Tests whether the current shortcut specifies a valid key combination. + + true if the current shortcut specifies a valid key combination; otherwise, false. + + + + Gets the shortcut used to activate particular functionality. + + The value representing the shortcut. + + + + Gets the name of the SHIFT key which is dependent upon the end-user’s regional settings. + + A string which specifies the name of the SHIFT key. + + + + Gets the text representation of the current shortcut. + + The text representation of the current shortcut. + + + + Provides simplified form layout panels: the DevExpress.Utils.Layout.StackPanel and DevExpress.Utils.Layout.TablePanel objects. + + + + + A panel that arranges its child elements in a single line, either vertically or horizontally. + + + + + Initializes a new instance of the StackPanel class with default settings. + + + + + Returns whether the control from the panel Controls collection occupies all available panel space. + + A Control whose stretch mode is to be obtained. + true if the control stretches; otherwise, false. + + + + Retrieves the object that provides current StackPanel settings. + + A StackPanelObjectInfoArgs object that provides current StackPanel settings. + + + + Gets or sets the direction along which this stack panel arranges its child controls. + + Specifies the layout direction for child stack panel items. + + + + Forces the control lying on the stack panel to occupy the entire free space available in this panel. The size of a stretched control cannot exceed this control’s MaximumSize. The control is strethed in the direction that matches the panel orientation (i.e., vertically for TopDown and BottomUp panels). + + A control from the panel’s Controls collection. + true, to stretch the control; otherwise, false. + + + + A panel with a table layout, where each cell can host a control. + + + + + Initializes a new instance of the TablePanel class with default settings. + + + + + Gets or sets the size of empty rows/columns of the type. + + The size for empty rows/columns of the type, in pixels. + + + + Provides access to the collection of the panel’s columns (). + + A collection of objects. + + + + If a target control lies in a Table Panel cell, this method returns the index of a column that owns this cell. + + The Control to check. + The index of a parent column. + + + + If a target control lies in a Table Panel cell and stretches horizontally across multiple cells, this method returns the number of columns this control occupies. + + The Control to check. + The number of columns across which this Control spans. + + + + If a target control lies in a Table Panel cell, this method returns the index of a row that owns this cell. + + The control to check. + The index of a parent row. + + + + If a target control lies in a Table Panel cell and stretches vertically across multiple cells, this method returns the number of rows this control occupies. + + The Control to check. + The number of rows across which this Control spans. + + + + Retrieves the object that provides current TablePanel settings. + + A TablePanelObjectInfoArgs object that provides current TablePanel settings. + + + + Provides access to the collection of the panel’s rows (). + + A collection of objects. + + + + Moves a control to a specific cell. Note that you should first add the control to the panel’s Controls collection. + + The Control to move. + The new index of a row. + The new index of a column. + + + + Places the control into a cell that belongs to this column. Note that this method can be called only for controls from the panel’s Controls collection. + + The control to move. + The new index of a Panel column. + + + + Stretches the control horizontally across the given number of cells. Note that this method can only be called for controls from the panel’s Controls collection. + + The stretched control. + The number of rows occupied by this control. + + + + Places the control into a cell that belongs to this row. Note that this method can be called only for controls from the panel’s Controls collection. + + The control to move. + The new index of a Panel row. + + + + Stretches the control vertically across the given number of cells. Note that this method can only be called for controls from the panel’s Controls collection. + + The stretched control. + The number of rows occupied by this control. + + + + Gets or sets whether this TablePanel should draw its grid lines at runtime. + + Specifies whether this panel should show its grid lines at runtime. The DefaultBoolean.Default setting is equal to DefaultBoolean.False. + + + + A column in the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + The column’s size type. + The column’s width. + The column’s visibility state. + + + + Initializes a new instance of the class with specified settings. + + The column’s size type. + The column’s width. + + + + Gets or sets the column’s width. + + The column’s width. + + + + The base class for columns and rows in the . + + + + + Gets or sets the size type of the current row/column. + + The size type of the current row/column. + + + + Gets or sets the unique ID for the current column or row. + + Any object that serves as the unique column or row ID. + + + + Returns the text representation of the current row/column. + + The text representation of the current row/column. + + + + Gets or sets whether the row/column is visible. + + The row/column’s visibility. + + + + Enumerates size types for rows and columns in the . + + + + + A row/column has a fixed width/height, in pixels. If the last row/column is of the Absolute size type and the TableLayout provides more space than needed, the row/column is stretched to fit this space. + + + + + Rows/columns are automatically resized to match their contents. Width and Height settings of these columns/rows are ignored. + The property specifies the size for empty rows/columns of this type. + You can also enable the TablePanel’s AutoSize property to automatically resize the panel to fit its contents. + + + + + Rows/columns of this size type divide the available space according to the ratio specified by their sizes. When you enable the TablePanel’s AutoSize setting, Relative mode is equivalent to AutoSize mode. + + + + + Rows and columns of this style serve as visual delimiters between their neighboring rows and columns. Separators cannot be resized and ignore their TablePanelColumn.Width and TablePanelRow.Height properties. + + + + + A row in the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + The row’s size type. + The row’s height. + The row’s visibility state. + + + + Initializes a new instance of the class with specified settings. + + The row’s size type. + The row’s height. + + + + Gets or sets the row’s height. + + The row’s height. + + + + The base class for the and classes. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the panel enables scrollbars that allow you to scroll to any controls placed outside the panel’s visible boundaries. + + true, to automatically show scrollbars; false, to hide scrollbars. + + + + Gets or sets the distance between child controls and the edges of the XtraLayoutPanel. The size of auto-scroll margins is added to the combined size of child controls inside this panel to determine whether scroll bars are needed. + + The auto-scroll margin size. + + + + Gets or sets the minimum screen size allocated to the automatic scroll bars. + + The minimum height and width of the scrollable area, in pixels. + + + + Gets or sets whether the panel maintains an automatic tab order of its child controls. + + true, if the panel automatically maintains the tab order of its controls according to the controls’ positions; false, if the tab order is specified by the Control.TabIndex property of the controls. + + + + Calculates the panel size required to fit the panel’s content. + + The required panel size. + + + + Gets or sets how s are vertically aligned in relation to the text editors displayed to the label’s right (to the label’s left in right-to-left locales). + + The label’s vertical position relative to the adjacent text editor. + + + + Gets the panel’s LayoutEngine object. + + The LayoutEngine for the panel’s contents. + + + + Unlocks the panel that was previously frozen by the SuspendLayout() method. + + + + + Resumes the layout behavior for the panel. + + true, to execute pending layout requests; otherwise, false. + + + + Temporarily freezes a panel to avoid exessive immediate updates. Call this method before you modify a panel layout in code. When all modifications are done, call the ResumeLayout method to unlock the panel. + + + + + Gets or sets whether Stack and Table panels obtain their margins and paddings from the current skin. + + true if Stack and Table panels obtain their margins and paddings from the current skin; otherwise, false. + + + + Contains values that specify how a specific element is positioned relative to another element. + + + + + An element is located at the bottom edge of another element. + + + + + The same as the Locations.Top option. + + + + + An element is located at the left edge of another element. + + + + + An element is located at the right edge of another element. + + + + + An element is located at the top edge of another element. + + + + + The Magnifier that allows users to pick colors from anywhere around the screen. + + + + + Initializes a new instance of the class with the default settings. + + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Initializes a new instance of the class with the specified settings. + + An IWin32Window object that owns this Magnifier. + A object that stores Magnifier settings. + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Displays the MagnifierDialog with custom parameters. + + A form that owns this dialog. + The initial zoom ratio. + true if the dialog should close when a user clicks the left mouse button, false if left clicks should not close the dialog. In the latter case, a user should press Esc to hide the magnifier. + Specifies whether a color under the magnifier crosshair should be copied to the clipboard when a user clicks the left mouse button. + Specifies whether the magnifier should store clicked colors as Hexadecimal or ARGB values. + true to show a pixel grid inside the magnifier; otherwise, false. + Specifies whether the magnifier should display the previously clicked and currently hovered colors in its upper right corner. + A structure that stores the last remembered magnifier zoom level and colors selected by a user. + + + + Displays the with specific parameters. + + An interface descendant that owns this . + An Int32 value that specifies the ‘s initial zoom level. + true if the should automatically close when a user presses the left mouse button; otherwise, false. + true to copy a clicked color to the clipboard; otherwise, false. + A ColorFormat enumeration value that specifies whether the should return selected colors as Hexadecimal or ARGB values. + true, to show a pixel grid inside the Magnifier; otherwise, false. + A object that stores selected colors and zoom level. + + + + Initializes a new instance of the class with the specified settings. + + An IWin32Window object that owns this Magnifier. + A Single value that is the initial Magnifier zoom level. Users can zoom in and out using a mouse scroll wheel. + true if the Magnifier should automatically close immediately after a user clicks the left mouse button to select a color; false if the Magnifier closes only when user presses “Esc” or clicks the right mouse button. + true if the selected color should be copied to the clipboard; otherwise, false. + A ColorFormat that specifies whether the Magnifier displays remembered and hovered colors in RGB or HEX format. + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Displays the with specific parameters. + + An interface descendant that owns this . + An Int32 value that specifies the ‘s initial zoom level. + true if the should automatically close when a user presses the left mouse button; otherwise, false. + true to copy a clicked color to the clipboard; otherwise, false. + A object that stores selected colors and zoom level. + + + + Initializes a new instance of the class with the specified settings. + + An IWin32Window object that owns this Magnifier. + A Single value that is the initial Magnifier zoom level. Users can zoom in and out using a mouse scroll wheel. + true if the Magnifier should automatically close immediately after a user clicks the left mouse button to select a color; false if the Magnifier closes only when user presses “Esc” or clicks the right mouse button. + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Initializes a new instance of the class with the specified settings. + + An IWin32Window object that owns this Magnifier. + A Single value that is the initial Magnifier zoom level. Users can zoom in and out using a mouse scroll wheel. + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Initializes a new instance of the class with the specified settings. + + An IWin32Window object that owns this Magnifier. + A object that stores the last remembered Magnifier zoom level and colors selected by a user. + + + + Provides settings that allow you to invoke the with specific settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Specifies whether a Magnifier should automatically close immediately after a user clicks the left mouse button to select a color. + + true if the Magnifier should automatically close immediately after a user clicks a left mouse button to select a color; false if the Magnifier closes only when user presses “Esc” or clicks the right mouse button. + + + + Gets or sets whether the Magnifier displays hovered and remembered colors in RGB or HEX format. + + A ColorFormat enumeration value that specifies whether the Magnifier displays hovered and remembered colors in RGB or HEX formats. + + + + Gets or sets the Magnifier start-up zoom level. End-users can scroll in and out by using a mouse scroll wheel. + + A Single value that specifies the Magnifier start-up zoom level. + + + + Gets or sets whether or not a color chosen by a user should be automatically copied to the clipboard. + + true, to copy a selected color to the clipboard; otherwise, false. + + + + Gets or sets whether the magnifier should display the currenly hovered and last clicked colors in its upper right corner. Colors are displayed as RGB or Hex values depending on the ColorFormat property value. + + true to display color codes in the upper right corner of the magnifier, false if color codes should be hidden. + + + + Gets or sets whether the should display a pixel grid inside its client area. + + true, to display a pixel grid; otherwise, false. + + + + An object that stores colors chosen by a user in the and the Magnifier’s last remembered zoom level. + + + + + Retrieves the last color under the Magnifier crosshair. + + A Color that was the last color under the Magnifier crosshair before the Magnifier closed. + + + + Retrieves the last color picked by a user. A user must click the left mouse button to select a color. + + A nullable Color value that is the last color picked by a user. + + + + Retrieves the last remembered Magnifier zoom level. + + A Single value that is the last remembered Magnifier zoom level. + + + + Contains classes that are used to implement context menus in DevExpress controls. + + + + + Base class for the popup (context) menu of Office-inspired controls. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified caption and the handler for the DXSubMenuItem.BeforePopup event. + + An event handler that will be invoked when the menu is about to be displayed. This value is assigned to the DXSubMenuItem.BeforePopup event. + + + + Find a menu item specified by its Id and disable it. + + An object serving as a menu identifier. + true to search nested menus recursively; otherwise, false. + + + + Find a menu item specified by its Id and disable it. + + An object serving as a menu identifier. + + + + Find a menu item specified by its Id and enable it. + + An object serving as a menu identifier. + true to search nested menus recursively; otherwise, false. + + + + Find a menu item specified by its Id and enable it. + + An object serving as a menu identifier. + + + + Searches for a menu item specified by its ID within a specified menu object. + + A object that is the menu from which a search starts. + An integer that is the position of the menu item within the menu object. + true, to search nested menus recursively; otherwise, false. + A object if the menu with a specified identifier is found; otherwise null (or Nothing in Visual Basic) + + + + Gets or sets menu identifier. + + An object serving as a menu identifier. + + + + Moves a menu item with a check mark to a specified position. + + An object serving as a menu identifier. + An integer that is the position of a menu item within the menu object. + + + + Moves a menu item to a specified position. + + An object serving as a menu identifier. + An integer that is the position of a menu item within the menu object. + + + + Moves a menu item to a specified position. + + A object that is the menu item. + An integer that is the position of a menu item within the menu object. + + + + Moves a submenu item to a specified position. + + An object serving as a menu identifier. + An integer that is the position of a menu item within the menu object. + + + + Find a menu item specified by its Id and remove it. + + An object serving as a menu identifier. + true, to search nested menus recursively; otherwise, false. + + + + Find a menu item specified by its Id and remove it. + + An object serving as a menu identifier. + + + + A group of buttons that can be displayed within a object. + + + + + Initializes a new instance with the default settings. + + + + + Represents a menu item that can be checked and unchecked. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified caption, image, check state and event handler. + + A string that specifies the menu item’s caption. This value is assigned to the DXMenuItem.Caption property. + A Boolean value that specifies the menu item’s check state. This value is assigned to the DXMenuCheckItem.Checked property. + An image that is displayed within the menu item. This value is assigned to the DXMenuItem.Image property. + An event handler that will be invoked when the check state is toggled. This value is assigned to the DXMenuCheckItem.CheckedChanged event. + + + + Initializes a new instance of the class with the specified caption and check state. + + A string that specifies the menu item’s caption. This value is assigned to the DXMenuItem.Caption property. + A Boolean value that specifies the menu item’s check state. This value is assigned to the DXMenuCheckItem.Checked property. + + + + Initializes a new instance of the class with the specified caption. + + A string that specifies the menu item’s caption. This value is assigned to the DXMenuItem.Caption property. + + + + Gets or sets a value indicating whether the menu item is checked. + + true if the menu item is checked; otherwise, false. + + + + Occurs when the menu item’s check state is toggled. + + + + + Represents a regular menu item. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified caption and display priority. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + A DXMenuItemPriority enumeration value that specifies the display priority for the current item in a . This value is assigned to the DXMenuItem.Priority property. + + + + Initializes a new instance of the class with the specified caption, display priority and Click event handler. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + An event handler that will be invoked when the menu item is clicked or selected. This value is assigned to the DXMenuItem.Click event. + A DXMenuItemPriority enumeration value that specifies the display priority for the current item in a . This value is assigned to the DXMenuItem.Priority property. + + + + Initializes a new instance of the class with the specified settings. + + The menu item’s caption. + The EventHandler object that handles the menu item’s Click event. + The DXMenuItem.SvgImage property value. + The DXMenuItem.Priority property value. + + + + Initializes a new instance of the class with the specified settings. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + An event handler that will be invoked when the menu item is clicked or selected. This value is assigned to the DXMenuItem.Click event. + An image that is displayed within the menu item. This value is assigned to the DXMenuItem.Image property. + An Image used to initialize the DXMenuItem.ImageDisabled property. + An Image used to initialize the DXMenuItem.LargeImage property. + An Image used to initialize the DXMenuItem.LargeImageDisabled property. + A DXMenuItemPriority enumeration value that specifies the display priority for the current item in a . This value is assigned to the DXMenuItem.Priority property. + + + + Initializes a new instance of the class with the specified settings. + + A string used to initialize the item’s DXMenuItem.Caption property. + A handler for the DXMenuItem.Click event. + An Image used to initialize the DXMenuItem.Image property. + An Image used to initialize the DXMenuItem.ImageDisabled property. + An Image used to initialize the DXMenuItem.LargeImage property. + An Image used to initialize the DXMenuItem.LargeImageDisabled property. + + + + Initializes a new instance of the class with the specified settings. + + A string used to initialize the item’s DXMenuItem.Caption property. + A handler for the DXMenuItem.Click event. + An Image used to initialize the DXMenuItem.Image property. + An Image used to initialize the DXMenuItem.ImageDisabled property. + + + + Initializes a new instance of the class with the specified caption, image and Click event handler + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + An event handler that will be invoked when the menu item is clicked or selected. This value is assigned to the DXMenuItem.Click event. + An image that is displayed within the menu item. This value is assigned to the DXMenuItem.Image property. + + + + Initializes a new instance of the class with the specified caption and Click event handler + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + An event handler that will be invoked when the menu item is clicked or selected. This value is assigned to the DXMenuItem.Click event. + + + + Initializes a new instance of the class with the specified caption. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + + + + Gets or sets whether the current icon should be painted in the ‘s foreground color. + + true if the current icon should be painted in the ‘s foreground color; otherwise, false. + + + + Provides access to the appearance settings used to paint the in the normal state. + + An object that contains the appearance settings. + + + + Provides access to the appearance settings used to paint the in the disbled state. + + An object that contains the appearance settings. + + + + Provides access to the appearance settings used to paint the in the hovered state. + + An object that contains the appearance settings. + + + + Gets or sets whether the current menu item starts a group. + + true if the menu item starts a group; otherwise, false. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Specifies the text displayed within the menu item. + + A string that specifies the text displayed within the menu item. + + + + Occurs when the menu item’s functionality needs to be invoked. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Gets the menu item collection which owns the current menu item. + + A DevExpress.Utils.Menu.DXMenuItemCollection collection which owns the current menu item. + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Releases all the resources used by the current object. + + + + + Gets or sets whether the menu item is enabled. + + true if the menu item is enabled; otherwise, false. + + + + Invokes the event handler assigned to the DXMenuItem.Click event. + + + + + Returns the actual raster image displayed by this . + + An ISvgPaletteProvider that colorizes SVG icons depending on the currently applied DevExpress skin. + An Image displayed by this . + + + + Returns the size of the image displayed by this . + + A Size structure that specifies the size of the image displayed by this . + + + + Returns whether the current menu item is actually aligned to support locales using right-to-left fonts. + + true if the current item is actually aligned to support locales using right-to-left fonts; otherwise, false. + + + + Returns whether or not this has an image assigned. + + true if this has an image assigned; otherwise, false. + + + + Gets or sets an image displayed within the menu item, + + A object that specifies the image displayed within the menu item. + + + + Gets or sets an image representing the menu item in the disabled state. + + An Image object representing the menu item in the disabled state. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.Utils.Menu.DXMenuItemImageOptions object that stores image-related options. + + + + Gets or sets whether the menu item is aligned to support locales using right-to-left fonts. + + true if the menu item is aligned to support locales using right-to-left fonts; otherwise, false. + + + + Gets or sets a large image for the current menu item. + + An Image object that is a large image for the current menu item. + + + + Gets or sets a large image displayed in the current menu item when it is in the disabled state. + + An Image object that is a large image displayed in the current menu item when it is in the disabled state. + + + + Gets or sets the object that owns this . + + An object that owns this . + + + + Gets or sets the display priority for the current item in a . + + A DXMenuItemPriority enumeration value that specifies the display priority for the current item in a . + + + + Gets or sets a shortcut displayed within the menu item + + A value that specifies a shortcut. + + + + Gets or sets whether the ampersand (‘&’) character, when it is found in the item’s DXMenuItem.Caption, acts as a shortcut prefix, or it is displayed as is. + + true if the ampersand (‘&’) character, when it is found in the item’s DXMenuItem.Caption, acts as a shortcut prefix; false if the ampersand (‘&’) is displayed as is. + + + + Gets or sets a super tip for this . + + A object assigned to this . + + + + Gets or sets the vector image that is this icon. + + An SvgImage object that is the vector image assigned to this . + + + + Gets or sets the data associated with the menu item. + + An object that contains the information which is associated with the menu item. + + + + Gets or sets whether the menu item is visible. + + true if the menu item is visible; otherwise, false. + + + + A base class for popup menus in DevExpress .NET controls. + + + + + This method supports internal infrastructure and is not intended to be used in code. + + + + + + This method supports internal infrastructure and is not intended to be used in code. + + + + + + + This method supports internal infrastructure and is not intended to be used in code. + + + + + + + Gets or sets the menu’s alignment relative to the mouse cursor. + + The ContentAlignment value that is the alignment of the menu relative to the mouse cursor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires after the menu has been closed. + + + + + For internal use. + + + + + This member supports the internal infrastructure and is not intended to be used directly from code. + + + + + + This method supports internal infrastructure and is not intended to be used in code. + + + + + + Fires a specific event that typically occurs after the menu has disappeared. + + + + + Returns whether the menu items are actually aligned to support locales using right-to-left fonts. + + true if menu items are actually aligned to support locales using right-to-left fonts; otherwise, false. + + + + Hides the current popup menu. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the menu is aligned to support locales using right-to-left fonts. + + true if the menu is aligned to support locales using right-to-left fonts; otherwise, false. + + + + Fires whenever a user clicks any item that belongs to this . + + + + + Specifies the maximum menu depth for all descendants in this solution. Menus with a nesting level that exceeds this value will be unable to expand certain sub-menu items. + + + + + Gets or sets how the current menu is displayed (as a menu, floating bar or ). + + A MenuViewType value + + + + Gets or sets whether items in this can be displayed in multiple columns. + + A enumerator value that specifies whether or not items in this can be displayed in multiple columns. + + + + Provides access to the set of properties that manage multi-column item layout in this . + + A DevExpress.Utils.Menu.OptionsMultiColumn object that stores properties which manage multi-column item layout in this . + + + + Gets or sets the object that created the current popup menu. For internal use. + + An object that created the current popup menu. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from code. + + + + + + This member supports the internal infrastructure and is not intended to be used directly from code. + + + + + + Gets or sets whether or not this should display its caption. This setting is in effect only when the menu is associated with the Bar Manager. + + + + + Gets or sets whether this items should display their hints. + + true if these items should display their hints; otherwise, false. + + + + Displays the at specific coordinates. For internal use. + + + + + Displays the at specific coordinates. + + A Control that is the parent control for this . + A Point structure that specifies the menu location. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Specifies a submenu. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified caption and the handler for the DXSubMenuItem.BeforePopup event. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + A handler for the DXSubMenuItem.BeforePopup event. + + + + Initializes a new instance of the class with the specified caption. + + A string that specifies the text displayed by the menu item. This value is assigned to the DXMenuItem.Caption property. + + + + Allows you to dynamically provide sub-items for the current object. + + + + + Invokes the event handler assigned to the DXSubMenuItem.BeforePopup event. + + + + + Gets a collection of items displayed when the current submenu is expanded. + + A DevExpress.Utils.Menu.DXMenuItemCollection object which contains menu items displayed when the submenu is expanded. + + + + Contains methods to operate on objects. + + + + + Hides the current popup control. + + + + + Displays the current popup control using a menu manager. + + An IDXMenuManager object that displays a popup control in a specific manner. + A parent control for the current popup control. + A position where a popup control will be displayed. + + + + Gets whether the current popup control is visible. + + true if the current popup control is visible; otherwise, false. + + + + Contains values that specify how a is displayed. + + + + + A menu is displayed as a regular popup menu. + + + + + A menu is displayed as a . + + + + + A menu is displayed as a popup bar. + + + + + Contains classes used to build MVVM-aware applications. + + + + + Generates View Models and manages their lifecycle. + + + + + Allows you to bind data types created by DevExpress MVVM Framework at runtime to a dependency injection framework. + + + + + A context item that allows an end-user to rate the content using the grading scale. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the glyph representing checked points. + + An Image that specifies the glyph representing checked points. + + + + Gets or sets whether the rating can be specified with precision up to integers, integers and half-integers, or decimals. + + A DevExpress.XtraEditors.RatingItemFillPrecision enumeration value that specifies the rating precision. + + + + Returns the Image object specifying the checked point glyph actually assigned. + + An ISkinProvider object. + The Image object specifying the checked point glyph actually assigned. + + + + Gets whether or not this has a checked point glyph assigned. + + true if this has a checked point glyph assigned; otherwise, false. + + + + Provides access to all properties related to the grading scale glyphs. + + A DevExpress.Utils.RatingContextButtonImageOptions object that stores all icon-related settings. + + + + Provides access to individual image-related property sets for every visual state - Normal, Hovered, and Checked. + + A DevExpress.Utils.RatingContextButtonImageOptionsCollection object that stores image-related settings for this . + + + + Gets or sets the number of points in the grading scale. + + An integer value that specifies the number of points in the grading scale. + + + + Gets or sets the rating specified by the current item. + + A decimal value that specifies the content rating. + + + + An image collection that allows you to share images between controls on multiple forms. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container. + + An object that implements the interface. + + + + Gets or sets whether or not s are allowed to modify the project resource file. + + true if s are allowed to modify the project resource file; otherwise, false. + + + + Notifies the image collection that initialization has started + + + + + Notifies the image collection that initialization is complete. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the inner collection of images for the . + + A object that is the inner collection of images. + + + + Gets the number of existing instances. + + An integer value that is the number of existing instances. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + The enumeration specifies the size of images being displayed within an object, when images are obtained from a . + + + + + The size of an image being displayed by an object is determined by the ImageSize property of the bound . + + + + + The size of an image being displayed by an object is determined by the size of the corresponding Image item in the bound . + + + + + The base class for simple context items’ options. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + An object that implements the IContextItemCollectionOptionsOwner interface and that owns a new . + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Simple context items do not support this setting. + + + + + + Represents a tooltip that supports multiple text and image regions. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether HTML formatting is allowed in this tooltip. + + , to enable HTML formatting; , to disable; , to use the ToolTipController.AllowHtmlText setting. + + + + This class does not support this proprty. Use a tooltip region’s Appearance property to specify appearance settings for the region. + + An object that specifies appearance settings. + + + + Copies the settings and contents of the specified tooltip to the current object. + + A source object. + + + + Returns a copy of the current object. + + A object which is a copy of the current tooltip. + + + + The default distance between items. This constant specifies the default value for the SuperToolTip.DistanceBetweenItems property. + + An integer value that specifies the default distance between items. + + + + Specifies the distance between tooltip regions (title, content, footer, etc.). + + An integer which specifies the distance between tooltip regions (title, content, footer, etc.). + + + + Gets or sets whether the tooltip width is fixed or corresponds to the content. + + true, if the tooltip width is fixed; false, if the tooltip is automatically resized to fit its content. + + + + Gets whether this tooltip contains regions. + + true if the collection is empty; otherwise, false. + + + + Determines whether the specified tooltip exists and has content. + + A super tooltip to check. + true if the target super tooltip does not exist or has no content; otherwise, false. + + + + Gets the collection of objects that represent regions (title, content, etc.) in a super tooltip. + + The collection of objects that represent regions (title, content, etc.) in a super tooltip. + + + + This class does not support this property. + + A object. + + + + Specifies the tooltip maximum width in pixels. + + An integer value that specifies the tooltip’s maximum width. + + + + Gets whether the tooltip controller allows you to use the HTML tags to format the text in this tooltip. + + true if the tooltip controller allows you to use the HTML tags to format the text in this tooltip; otherwise, false. + + + + Gets or sets the padding (space between the content of the tooltip and its edge). + + A structure that specifies the space between the content of the tooltip and its edge. + + + + Gets or sets whether tooltip’s visual elements are aligned to support locales using right-to-left fonts. + + true if tooltip’s visual elements are aligned to support locales using right-to-left fonts; otherwise, false. + + + + Creates tooltip items based on the specified setup information. + + A DevExpress.Utils.SuperToolTipSetupArgs object which contains initialization information. + + + + Gets the textual representation of the current . + + A string which specifies the tooltip’s textual representation. + + + + Stores vector images added by you and provides these images to DevExpress controls. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An IContainer that specifies an object that owns this . + + + + Clears this collection and optionally disposes of its images. + + true to dispose of collection images; otherwise, false. + + + + Generates a new instance filled with images from a project assembly. + + An Assembly that contains the target embedded resource images. + An object that contains images from a project assembly. + + + + Generates a new instance filled with images from a project assembly. + + A String value that specifies the path to assembly images within a project. + An Assembly that contains the target embedded resource images. + A object that contains images from a project assembly. + + + + Returns the SvgImageInfo objects for all images owned by this . + + A DevExpress.Utils.SvgImageInfoCollection object that stores information for all the images. + + + + Contains classes implementing the functionality of the . + + + + + Contains classes supporting the functionality of the . + + + + + Defines the set of values that specify the position of the Frequent/Recent category in the Jump List. + + + + + The Frequent/Recent category is displayed at the bottom of the Jump List. + + + + + The Frequent/Recent category is displayed at the top of the Jump List. + + + + + Defines the set of values that specify whether the Frequent category or Recent category is displayed in the Jump List, or none of them are displayed. + + + + + The Frequent Category is displayed in the Jump List. This category contains the list of files that are frequently opened with the current application. + + + + + Neither Frequent nor Recent category is displayed in the Jump List. + + + + + The Recent Category is displayed in the Jump List. This category contains the list of files that are recently opened with the current application. + + + + + Contains values that specify the type of progress indicator to be displayed within taskbar buttons. + + + + + The same as the Normal mode, but the progress bar turns red to indicate that an error has occurred. + + + + + + An indeterminate marquee-style progress indicator, which cycles repeatedly along the length of the taskbar button. + + + + + + + Stops displaying progress and returns the button to its regular state. + + + + + The determinate progress indicator that grows in size from left to right. Advance the progress value with the TaskbarAssistant.ProgressCurrentValue property. + + + + + + The same as the Normal mode, but the progress turns yellow to indicate that progress is currently stopped. + + + + + + This interface supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Represents a custom category in a Jump List. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A string value that is used to initialize the JumpListCategory.Caption property. + + + + Gets or sets a caption of the . + + A caption of the . + + + + Gets or sets a collection of tasks in the . + + A collection of tasks in the . + + + + Represents the collection of objects. + + + + + Initializes a new instance of the class. + + + + + Releases all resources used by elements of the . + + + + + Represents the collection of items in a Jump List category. + + + + + Initializes a new instance of the class. + + + + + Releases all resources used by elements of the . + + + + + Represents the separator that separates tasks in the TaskbarAssistant.JumpListTasksCategory. + + + + + Initializes a new instance of the class. + + + + + Converts an object to its string representation. + + This method returns “Separator”. + + + + Represents a task in a Jump List. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A string value that is used to initialize the JumpListItemTask.Caption property. + + + + Gets or sets the arguments for a command file specified in the JumpListItemTask.Path property. + + The arguments for a command file specified in the JumpListItemTask.Path property. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets a caption of the . + + A caption of the . + + + + Fires when a task has been clicked. + + + + + Creates a new object that is a copy of the current . + + A new object that is a copy of the current . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the task description shown in the tooltip. + + A String value that specifies the task description shown in the tooltip. + + + + Gets or sets the index of an icon contained in the image source specified by the JumpListItemTask.IconPath property or in the resources of the TaskbarAssistant.IconsAssembly assembly. + + The index of an icon that is contained in the assembly resources. + + + + Gets or sets the path to an assembly or an image that is used to specify the icon for the current task. + + A string value that specifies the path to an assembly or an image that is used to specify the icon for the current task. + + + + Gets or sets the full path to a destination folder or a file that is launched by the . + + The full path to a destination folder or a file that is launched by the . + + + + Raises the JumpListItemTask.Click event. + + + + + Gets or sets whether the program starts minimized, maximized, or normally. + + The WindowShowCommand enumeration value that specifies whether the program starts minimized, maximized, or normally. The default value is WindowShowCommand.Normal. + + + + Gets or sets the current directory for a process launched with a click on the current task. + + The current directory for a process that is launched with a click on the . + + + + Provides methods to manipulate an application taskbar button, Jump List and thumbnail preview. + + + + + Initializes a new instance of the class. + + + + + Assigns the specified parent control to the current component. + + A Control to be assigned the current component. + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Gets the default component. + + The default component. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Flashes the parent window. It does not change the window’s active state. + + A FlashFlags enumeration value that specifies the flash status (flash the window caption, flash the taskbar button, flash continuously until the window comes to the foreground, etc.). The enumeration supports bitwise operations, you can enable multiple flags. + An integer value that specifies the number of flashes. + An integer value that specifies the flash rate, in milliseconds. 0 to use the default cursor blink rate. + true if the window caption was drawn as active before the call; otherwise, false + + + + Gets or sets the name of the assembly that contains icons (in resources) for Jump List tasks. + + A string value that specifies the name of the assembly that contains icons (in resources) for Jump List tasks. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Provides access to the collection of custom categories in the Jump List. + + The collection of custom categories in the Jump List. + + + + Gets or sets the position of the Frequent or Recent category in the Jump List. + + The position of the Frequent or Recent category in the Jump List. + + + + Gets or sets which category (Recent or Frequent) is enabled in the Jump List. + + A value that specifies which category (Recent or Frequent) is enabled in the Jump List. + + + + Provides access to the collection of items within the standard Tasks category in the Jump List. + + The collection of items within the standard Tasks category in the Jump List. + + + + The maximum number of thumbnail buttons in the live thumbnail preview. This field is equal to 7. + + + + + Gets or sets a small overlay icon displayed over the application icon. + + A small overlay icon displayed over the application icon. + + + + Gets or sets the Control to which the current is bound. + + A System.Windows.Forms.Control object to which the current is bound. + + + + Gets or sets the current value of a progress indicator within an application’s taskbar button. + + The current value of a progress indicator within an application’s taskbar button. + + + + Gets or sets the maximum value of a progress indicator within an application’s taskbar button. + + The maximum value of a progress indicator within an application’s taskbar button. + + + + Gets or sets the type of progress indicator within the taskbar button. + + A value that specifies the type of progress indicator within the taskbar button. + + + + Updates the application taskbar button. + + + + + Provides access to the collection of buttons displayed in the toolbar in the live thumbnail preview. + + A collection of toolbar buttons in the live thumbnail preview. + + + + Gets or sets the region of the application window that is used as a thumbnail in the live thumbnail preview. + + The region of the application window that is used as a thumbnail in the live thumbnail preview. + + + + Gets or sets whether a single instance of the Jump List is used for all instances of the current application. + + true, if a single instance of the Jump List is used for all instances of the current application; false if every application instance uses its own Jump List instance. + + + + Provides data for the ThumbnailButton.Click event. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the window handle that the is bound to. + + The window handle that the is bound to. + + + + Gets the that raised the event. + + The that raised the event. + + + + A button within the live thumbnail preview window. + + + + + Initializes a new instance of the class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when the button is clicked. + + + + + Gets or sets whether a click on this button automatically closes the live thumbnail preview. + + true if the live thumbnail preview is automatically closed on clicking the button; otherwise, false. + + + + Gets or sets whether the button is enabled. + + true if the button is enabled; otherwise, false. + + + + Gets or sets the image displayed within the button. + + The image displayed within the button. + + + + Gets or sets whether the button’s pressed state is visually indicated. + + true if the button’s pressed state is visually indicated; otherwise, false. + + + + Gets or sets the button’s tooltip. + + The button’s tooltip. + + + + Gets or sets whether the button is visible. + + true if the button is visible; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Represents the collection of objects. + + + + + Initializes a new instance of the class. + + + + + Disposes the current object and releases all the allocated resources. + + + + + Contains options that specify how text is rendered. + + + + + Initializes a new instance of the class with the specified owner, the text settings are set to default values. + + An object which becomes the owner of the current object. + + + + Initializes a new instance of the class with the specified alignments, word wrapping and text trimming options. + + A value that specifies the horizontal alignment of text. This value is assigned to the TextOptions.HAlignment property. + A value that specifies the vertical alignment of text. This value is assigned to the TextOptions.VAlignment property. + A value that specifies word wrapping mode. This value is assigned to the TextOptions.WordWrap property. + A value that specifies text trimming mode. This value is assigned to the TextOptions.Trimming property. + A enumeration value that specifies the hotkey prefix for the text. This value is assigned to the TextOptions.HotkeyPrefix property. + + + + Initializes a new instance of the class with the specified alignments, word wrapping and text trimming options. + + A value that specifies the horizontal alignment of text. This value is assigned to the TextOptions.HAlignment property. + A value that specifies the vertical alignment of text. This value is assigned to the TextOptions.VAlignment property. + A value that specifies word wrapping mode. This value is assigned to the TextOptions.WordWrap property. + A value that specifies text trimming mode. This value is assigned to the TextOptions.Trimming property. + + + + Copies settings from the specified object to the current object. + + A object whose settings are copied to the current object. + + + + Prevents a text’s visual updates when are modified, until the or method is called. + + + + + Enables a text’s visual updates if the text was previously locked by the method. Does not cause the text’s immediate visual update. + + + + + Gets an object that specifies the default text options. + + A object that specifies the default text options. + + + + Gets an object whose settings force text to be centered. + + A object with its settings set to the corresponding values. + + + + Gets an object whose settings allow text to wrap. + + A object with its settings set to the corresponding values. + + + + Gets an object whose settings prevent text from wrapping. + + A object with its settings set to the corresponding values. + + + + Gets an object whose settings force text to be centered and prevent it from wrapping. + + A object with its settings set to the corresponding values. + + + + Gets an object that contains the default formatting settings. + + A object containing the default formatting settings. + + + + Enables a text’s visual updates if the text was previously locked by the method. Causes the text’s immediate visual update. + + + + + Specifies how the default string format referred to by the TextOptions.DefaultStringFormat property is constructed. + + + + + Returns an object that contains text alignment information and OpenType features. + + An object that contains text layout information, display manipulations, and OpenType features. + + + + Returns an object that contains text alignment information and OpenType features. + + An object with text options. + An object that contains text layout information, display manipulations, and OpenType features. + + + + Returns a object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object. + + A object whose properties are set to match the appropriate values. + + + + Returns a object whose settings reflect the alignment, word wrapping and text trimming options of the specified object. + + A object whose settings are used to initialize the corresponding settings of the object that is to be returned. + A object whose properties are set to match the appropriate values. + + + + Returns a StringFormatInfo object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object. + + A StringFormatInfo object whose properties are set to match the appropriate values. + + + + Returns a StringFormatInfo object whose settings reflect the alignment, word wrapping and text trimming options of the TextOptions.DefaultOptions object. + + A object whose settings are used to initialize the corresponding settings of the StringFormatInfo object that is to be returned. + A StringFormatInfo object whose properties are set to match the appropriate values. + + + + Gets or sets the horizontal alignment of text. + + A value that specifies the text horizontal alignment. + + + + Converts the specified value to a corresponding value. + + A value that is to be converted. + A value that corresponds to the specified value. + + + + Gets or sets whether to underline characters that are preceded with an ampersand symbol (&). This option is supported by a set of controls. + + A value that specifies how to interpret an ampersand character (&) in text. + + + + Tests whether two objects have the same property values. + + The object to which the current object is compared. + true if the current object has the same property values as the specified object; otherwise, false. + + + + Resets all the text settings to their default values. + + + + + Gets or sets whether the text is directed from right to left. + + true if the text is directed from right to left; otherwise, false. + + + + Specifies a text’s horizontal alignment within a control. + + The text’s horizontal alignment. + + + + This is an internal method that should not be called directly from your code. + + + + + + Sets the TextOptions.HotkeyPrefix property without the property changed notifications. + + A enumeration value which represents the hotkey prefix for the text. + + + + Returns the text representation of the current object. + + The text representation of the current object. + + + + Gets or sets text trimming mode. + + A value that specifies text trimming mode. + + + + For internal use. Copies settings from the specified object to the current object. + + A object whose settings are copied to the current object. + + + + Gets or sets the vertical alignment of text. + + A value that specifies the text vertical alignment. + + + + Converts the specified value to a corresponding value. + + A value that is to be converted. + A value that corresponds to the specified value. + + + + Gets or sets text wrapping mode. + + A value that specifies text wrapping mode. + + + + Provides data for events that maintain the Asynchronous Image Load feature. + + + + + Initializes a new instance of the class with the specified settings. + + The index of the currently processed item among other items. This value is used to initialize the ThumbnailImageEventArgs.DataSourceIndex property. + An object that performs image load. + An object that stores detailed information about the item. + + + + Creates a thumbnail image of the specific size. This image will be later assigned to an item that supports the asynchronous image load feature. + + An Image that will be transformed to the thumbnail image. + A Size structure that is the size of the thumbnail image. + An Image created by this method. + + + + Creates a thumbnail image that will be assigned to an item that supports the asynchronous image load feature. + + An Image that will be transformed to the thumbnail image. + An Image created by this method. + + + + Gets the index of the currently processed item among other items in the source (the item’s index in the bound data source for data-aware controls, e.g., ). + + An Int32 value that specifies the index of the currently processed item among other items in the source. + + + + Stores the desired size of thumbnail images, generated using the ThumbnailImageEventArgs.CreateThumbnailImage method. + + A Size structure that is the desired size of thumbnail images, generated using the ThumbnailImageEventArgs.CreateThumbnailImage method. + + + + Resets the image cache and causes all items that are not currently visible to reload their images when displayed again. + + + + + Gets or sets the image that will be assigned to an item that fired this event. + + An Image that will be assigned to an item that fired this event. + + + + Contains tooltip information. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified identifier, tooltip text and icon type. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A value that specifies the kind of predefined icon to display in a tooltip. This value is assigned to the ToolTipControlInfo.IconType + + + + Initializes a new instance of the class with the specified identifier, tooltip text, icon type and delay flag. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A Boolean value that specifies whether a tooltip needs to be displayed immediately or after a delay. This value is assigned to the ToolTipControlInfo.ImmediateToolTip property. + A value that specifies the kind of predefined icon to display in a tooltip. This value is assigned to the ToolTipControlInfo.IconType + + + + Initializes a new instance of the class with the specified identifier, tooltip text, title and icon type. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A string that specifies a tooltip’s title. This value is assigned to the ToolTipControlInfo.Title property. + A value that specifies the kind of predefined icon to display in a tooltip. This value is assigned to the ToolTipControlInfo.IconType + + + + Initializes a new instance of the class with the specified settings. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A string that specifies a tooltip’s title. This value is assigned to the ToolTipControlInfo.Title property. + A Boolean value that specifies whether a tooltip needs to be displayed immediately or after a delay. This value is assigned to the ToolTipControlInfo.ImmediateToolTip property. + A value that specifies the kind of predefined icon to display in a tooltip. This value is assigned to the ToolTipControlInfo.IconType + A value that specifies whether HTML formatting is supported in tooltips. This value is assigned to the ToolTipControlInfo.AllowHtmlText property + + + + Initializes a new instance of the class with the specified identifier, tooltip text, title, icon type and delay flag. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A string that specifies a tooltip’s title. This value is assigned to the ToolTipControlInfo.Title property. + A Boolean value that specifies whether a tooltip needs to be displayed immediately or after a delay. This value is assigned to the ToolTipControlInfo.ImmediateToolTip property. + A value that specifies the kind of predefined icon to display in a tooltip. This value is assigned to the ToolTipControlInfo.IconType + + + + Initializes a new instance of the class with the specified identifier, tooltip text and title. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + A string that specifies a tooltip’s title. This value is assigned to the ToolTipControlInfo.Title property. + + + + Initializes a new instance of the class with the specified identifier and tooltip text. + + An object used as an identifier of the currently processed visual element. This value is assigned to the ToolTipControlInfo.Object property. + A string that specifies a tooltip’s text. This value is assigned to the ToolTipControlInfo.Text property. + + + + Gets or sets whether HTML formatting is supported in tooltips. + + A value that specifies whether HTML formatting is supported in tooltips. + + + + Gets or sets a control shown within a flyout tooltip. + + + + + Gets or sets whether the tooltip should be forcibly shown for the same visual element via the ToolTipController.ShowHint method. + + A enumeration value that specifies whether the tooptip should be forcibly shown for the same visual element. + + + + Gets or sets whether the shown tooltip hides when an end-user moves the mouse. + + A Boolean value specifying whether the shown tooltip hides when an end-user moves the mouse. + + + + Gets or sets the kind of predefined icon to display in a tooltip. + + A value specifying the kind of predefined icon to display. + + + + Provides access to options that specify the image displayed in the tooltip. + + An object that contains image options. + + + + Gets or sets whether a tooltip will be displayed immediately or after a delay. + + A Boolean value that specifies whether a tooltip will be displayed immediately after an event handler call. + + + + Gets or sets the interval that must pass before a tooltip is displayed. + + An integer value that specifies the delay, in milliseconds. + + + + Removes the ‘0x0’ character from the ToolTipControlInfo.Text and ToolTipControlInfo.Title strings. + + + + + Gets or sets an object which uniquely identifies the currently processed element. + + An object which uniquely identifies the currently processed element. + + + + Gets or sets the bounds of the object for which a tooltip is displayed. + + The bounds of the object for which a tooltip is displayed. + + + + Gets or sets a that will be displayed if the ToolTipControlInfo.ToolTipType property is set to SuperTip + + A object that has been assigned to this property. The default value is null. + + + + Gets or sets the tooltip’s text. + + A string that specifies the tooltip’s text. + + + + Gets or sets the tooltip’s title. + + A string that specifies the tooltip’s title. + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or the owning control. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether the tooltip is anchored relative to the mouse pointer or the owning control. + + + + Gets or sets the image to display within the current tooltip. + + An object that specifies the image to display within the current tooltip. + + + + Gets or sets the space, in pixels, between the tooltip and the associated visual element. + + An integer value specifying the space, in pixels, between the tooltip and the associated visual element. The default is 16. + + + + Gets or sets the tooltip location. + + A enumeration value. + + + + Gets or sets the tooltip’s position in screen coordinates. + + A structure that specifies the tooltip’s position, in pixels, relative to the top left corner of the screen. + + + + Gets or sets the type of tooltip to be displayed. + + A value that specifies the type of tooltip to be displayed. + + + + Provides tooltip management for individual controls. + + + + + Creates a new instance of the class. + + + + + Initializes a new instance of the class with the specified container. + + A that represents the container for the tooltip controller. + + + + Gets or sets whether the component’s functionality is enabled. + + true if displaying tooltips is allowed; otherwise, false. + + + + Gets the active control, if it implements the IToolTipControlClient interface. + + A DevExpress.Utils.IToolTipControlClient object. + + + + Returns the object that identifies which of the bound control’s elements the tooltip is displayed for. + + A object representing the bound control’s element that the tooltip is displayed for. + + + + An object containing tooltip information for the current element of a bound control. + + A object containing tooltip information for the current element of a bound control. + + + + Enables the display of tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface. + + + + + Enables the display of tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface. + + The control, implementing the DevExpress.Utils.IToolTipControlClient interface, for which tooltips should be enabled. + + + + Gets or sets whether HTML formatting tags can be used to format text in tooltips. + + true if HTML tags can be used to format text in tooltips; otherwise, false. + + + + Gets or sets the settings that control the appearance of a tooltip’s window and text. + + An object that contains the appearance settings. + + + + Provide the settings that control the appearance of a tooltip’s title. + + An object that contains the appearance settings. + + + + Gets or sets the timeframe during which a tooltip is visible on-screen. + + An integer value that specifies the duration of the tooltip, in ms. + + + + Fires when a tooltip is about to be displayed. Allows you to dynamically specify the tooltip text, image, and appearance settings. + + + + + Enables you to specify the position and size of the tooltip window. + + + + + Gets or sets whether a tooltip is closed on a click. + + A value that specifies whether a click on a tooltip closes this tooltip. + + + + Returns a object containing settings of the current tooltip controller. + + A object with settings of the current tooltip controller. + + + + Enables a tooltip’s window to be custom painted. + + + + + Gets the default used for displaying tooltips. + + A default object. + + + + Allows you to display custom tooltips for any UI element of a control that implements the DevExpress.Utils.IToolTipControlClient interface. + + + + + Returns whether HTML formatting is enabled in tooltips for the specified control. + + A control for which this tooltip setting is to be obtained. + A value that specifies whether HTML formatting is supported in tooltips for the specified control. + + + + Gets a object associated with the specified control. + + The control whose SuperToolTip object is to be obtained. + A object associated with the control. + + + + Gets a regular tooltip’s title displayed within the specified control. + + A control whose regular tooltip’s title is to be obtained. + A string representing a regular tooltip’s title for the control. + + + + Gets a regular tooltip for the specified control. + + A control whose tooltip should be obtained. + A string representing a regular tooltip for the control. + + + + Gets whether the tooltip associated with the specified control is anchored relative to the mouse pointer or the owning control. + + The control from which to retrieve how the associated tooltip is anchored. + A ToolTipAnchor value that specifies how the tooltip associated with the specified control is anchored. + + + + Gets the type of the icon displayed within the specified control’s regular tooltip. + + A control whose tooltip’s icon type is to be obtained. + A value representing the type of the icon displayed within the specified control’s regular tooltip. + + + + Hides the hint if it is being displayed. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + An HTML & CSS template applied to regular hints and Super Tooltips of controls whose tooltips are managed by this ToolTipController. + + The template applied to control tooltips. + + + + Occurs when a user clicks a hyperlink within a control’s tooltip or super tooltip. + + + + + Gets or sets the tooltip icon size. + + The enumeration value that specifies the icon size. + + + + Gets or sets the tooltip icon type. This property is obsolete, use instead. + + The enumerator. + + + + Gets or sets the index of an image to be displayed within tooltips. + + The integer value specifying the index of an image to be displayed within tooltips. + + + + Gets or sets the source of the images that can be displayed within tooltips. + + An object that is the source of images that can be displayed within tooltips. + + + + Gets or sets the time interval between a visual element being hovered, and its tooltip being shown on-screen. + + Integer value that specifies the time a visual element needs to display its tooltip. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether a displayed tooltip remains visible while the mouse cursor keeps moving (without pauses) towards the tooltip and while it hovers the tooltip. + + true if a tooltip remains displayed while the mouse cursor is over this tooltip; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Disables displaying tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface. + + The control, implementing the DevExpress.Utils.IToolTipControlClient interface, for which the ‘s functionality should be disabled. + + + + Resets the timer which controls when a tooltip’s window is hidden. + + + + + Gets or sets the time interval that must pass before another hint is displayed if another hint is currently visible. + + An integer value specifying the time interval in milliseconds. + + + + Gets or sets whether the tooltip’s corners are rounded. + + true to display hints with rounded corners; otherwise, false. + + + + Gets or sets the radius of the rounded corners of the tooltip window. + + The radius of the rounded corners. + + + + Sets whether HTML formatting is enabled in tooltips for the specified control. + + A control for which the tooltip information is to be changed. + A value that specifies whether HTML formatting is enabled in tooltips for the specified control. + + + + Associates a object with the specified control. + + A control for which to set the tooltip. + A object to associate with the control. + + + + Sets a regular tooltip’s title for the specified control. + + A control for which to set a regular tooltip’s title. + A string representing a regular tooltip’s title. + + + + Sets a regular tooltip for the specified control. + + A control for which to set the tooltip. + A string representing a regular tooltip’s text. + + + + Sets whether the tooltip associated with the specified control is anchored relative to the mouse pointer or the owning control. + + The control from which to set how the tooltip is anchored. + A value that specifies whether the tooltip is anchored relative to the mouse pointer or the owning control. + + + + Sets the type of the icon displayed within the specified control’s regular tooltip. + + A control for which the icon type is set. + A value representing the type of the icon that should be displayed within the specified control’s regular tooltip. + + + + Tests whether callout beaks are displayed for hints. + + true if the callout beak is displayed when a hint appears; otherwise, false. + + + + Displays a hint using the specified tooltip information. + + A object containing information for displaying a hint. + + + + Displays a hint relative to a specific point using specified settings. + + A object specifying settings for displaying tooltips. + A point relative to which the hint should be displayed. + + + + Displays a hint for a control using specified settings. + + A object specifying the settings used to display tooltips. + The control for which to display the tooltip. + + + + Displays a hint relative to the mouse cursor using specified settings. + + A object specifying settings for displaying tooltips. + + + + Displays a hint at a specified position relative to a specific point. + + The text to display as a tooltip. + The position relative to the specified point at which the hint should be displayed. + The point relative to which the hint should be displayed. + + + + Displays a hint at the specified position relative to the mouse cursor. + + The text to display as a tooltip. + The position relative to the mouse cursor at which the hint should be displayed. + + + + Displays a hint relative to the specified point using current settings + + The text to display as a tooltip. + The point relative to which the tooltip should be displayed. + + + + Displays a hint with the specified text and title relative to the specified point. + + A string that represents a tooltip’s text. + A string that represents a tooltip’s title. + The position relative to the specified control at which the tooltip should be displayed. + A point relative to which the hint should be displayed. + + + + Displays a hint with the specified text and title relative to the mouse cursor’s position. + + A string that represents a tooltip’s text. + A string that represents a tooltip’s title. + The position relative to the specified control at which the tooltip should be displayed. + + + + Displays a hint with the specified text and title at the specified point using the current settings + + A string that represents a tooltip’s text. + A string that represents a tooltip’s title. + A point relative to which the hint should be displayed. + + + + Displays a hint with the specified text and title relative to the specified control. + + A string which represents the tooltip’s text. + A string which represents the tooltip’s title. + The control to display the tooltip for. + The position relative to the specified control at which the tooltip should be displayed. + + + + Displays a hint with the specified text and title relative to the mouse cursor using the current settings. + + A string that represents a tooltip’s text. + A string that represents a tooltip’s title. + + + + Displays a hint relative to a specific control. + + The text to display as a tooltip. + The control for which to display the tooltip. + The position relative to the specified control at which the tooltip should be displayed. + + + + Displays a hint relative to the mouse cursor using current settings. + + The text to display as a tooltip. + + + + Gets or sets whether the tooltips are shown shadowed. + + true if the tooltips are shown shadowed; otherwise, false. + + + + Gets the appearance settings used to paint the hints of bound controls. + + An object which provides the appearance settings used to paint the hints of bound controls. + + + + Gets or sets whether tooltips are anchored relative to the mouse pointer or relative to the owning control. This property is not in effect if you handle the ToolTipController.GetActiveObjectInfo event. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether tooltips are anchored relative to the mouse pointer or relative to the owning control. By Default, tooltips are anchored relative to the mouse pointer. + + + + Gets or sets the tooltip location. + + The enumerator. + + + + Gets or sets the look-and-feel of regular tooltips. + + A value that specifies the look-and-feel of regular tooltips. + + + + Gets or sets the type of tooltips displayed by the controller. + + A value that specifies the type of tooltips to be displayed. + + + + Obsolete. Gets or sets whether the default style should be used for the hint. + + true if the default style is applied to the hint; false if the ToolTipController.Style is used + + + + Represents a method that will handle the ToolTipController.BeforeShow event. + + The event source. This identifies the component which fires the event. + A object containing data related to the event. + + + + Provides data for the ToolTipController.CalcSize event. + + + + + Initializes a new instance of the class with the specified settings. + + An object for which the event is fired. This value is assigned to the ToolTipControllerEventArgsBase.SelectedControl property. + An object which identifies the element that the tooltip is displayed for. This value is assigned to the ToolTipControllerEventArgsBase.SelectedObject property. + A object that provides additional event data. This value is assigned to the ToolTipControllerCalcSizeEventArgs.ShowInfo property. + + + + Initializes a new instance of the class with the specified settings. + + An object for which the event is fired. This value is assigned to the ToolTipControllerEventArgsBase.SelectedControl property. + An object which identifies the element which the tooltip is displayed for. This value is assigned to the ToolTipControllerEventArgsBase.SelectedObject property. + A value which specifies the tooltip’s contents. This value is assigned to the ToolTipControllerCalcSizeEventArgs.ToolTip property. + A value which specifies the tooltip’s title. This value is assigned to the ToolTipControllerCalcSizeEventArgs.Title property. + A structure which specifies the tooltip’s bounds. This value is assigned to the ToolTipControllerCalcSizeEventArgs.Size property. + A structure which specifies the screen coordinates of the top left tooltip corner. This value is assigned to the ToolTipControllerCalcSizeEventArgs.Position property. + + + + Initializes a new instance of the class with the specified settings. + + An object for which the event is fired. This value is assigned to the ToolTipControllerEventArgsBase.SelectedControl property. + An object which identifies the element for which the tooltip is displayed. This value is assigned to the ToolTipControllerEventArgsBase.SelectedObject property. + A value which specifies the tooltip’s contents. This value is assigned to the ToolTipControllerCalcSizeEventArgs.ToolTip property. + A value which specifies the tooltip’s title. This value is assigned to the ToolTipControllerCalcSizeEventArgs.Title property. + + + + Gets or sets the coordinates of the top left tooltip corner. + + The object specifying the coordinates of the top left tooltip corner relative to the desktop. + + + + Gets the additional event data. + + A object that provides additional event data. + + + + Gets or sets the tooltip dimensions. + + The object specifying the width and height of a tooltip rectangle. + + + + Gets the tooltip’s title. + + A value which specifies the tooltip’s title. + + + + Gets the text to be displayed within the tooltip. + + The object specifying the text to be displayed within the tooltip. + + + + Represents a method that will handle the ToolTipController.CalcSize event. + + The event source. This identifies the component which fires the event. + A object containing data related to the event. + + + + Provides data for the ToolTipController.CustomDraw event. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the ToolTipControllerCustomDrawEventArgs.Cache property. + A object which provides the information required to paint a tooltip. This value is assigned to the ToolTipControllerCustomDrawEventArgs.ShowInfo property. + A structure which specifies the tooltip’s boundaries. This value is assigned to the ToolTipControllerCustomDrawEventArgs.Bounds property. + + + + Gets the bounding rectangle of the painted tooltip. + + A structure which specifies the tooltip’s boundaries. + + + + Gets an object which specifies the storage for the most used pens, fonts and brushes + + A object which specifies the storage for the most used pens, fonts and brushes. + + + + Gets or sets whether an event was handled, if it was handled the default actions are not required. + + true if default painting isn’t required; otherwise, false. + + + + Gets an object which provides the information required to paint a tooltip. + + A object which provides the information required to paint a tooltip. + + + + Represents a method that will handle the ToolTipController.CustomDraw event. + + The event source. This parameter identifies the tooltip controller which raised the event. + A object that contains event data. + + + + The base class for classes providing data for ‘s events. + + + + + Creates an instance of the class. + + + + + Creates an instance of the class. + + The object to initialize the ToolTipControllerEventArgsBase.SelectedControl property. + The object to initialize the ToolTipControllerEventArgsBase.SelectedObject property. + + + + Gets or sets the control for which a tooltip controller’s event is fired. + + A object for which the event is fired. + + + + Gets or sets the element of the control for which the tooltip should be displayed. + + An object defining the element for which to display the tooltip. + + + + Provides data for the ToolTipController.GetActiveObjectInfo event. + + + + + Initializes a new instance of the class with the specified settings. + + The control for which a tooltip controller’s event is fired. This value is assigned to the ToolTipControllerEventArgsBase.SelectedControl property. + The element of the control (or the type of the element) for which the tooltip is displayed. This value is assigned to the ToolTipControllerEventArgsBase.SelectedObject property. + An object which uniquely identifies the current element for which the tooltip is displayed. This value is assigned to the ToolTipControllerGetActiveObjectInfoEventArgs.Info property. + A structure that specifies the position of the mouse cursor relative to the control’s upper left corner. This value is assigned to the ToolTipControllerGetActiveObjectInfoEventArgs.ControlMousePosition property. + + + + Gets the position of the mouse cursor relative to the control’s upper left corner. + + A structure that specifies the position of the mouse cursor relative to the control’s upper left corner. + + + + Gets or sets an object which uniquely identifies the visual element at the current position. + + A object which identifies the visual element at the current position. + + + + Represents a method that will handle the ToolTipController.GetActiveObjectInfo event. + + The event source. This parameter identifies the ToolTip Controller which fires this event. + A object that contains event data. + + + + Provides data for the ToolTipController.BeforeShow event. + + + + + Creates an instance of the class and initializes properties with default values + + + + + Initializes a new instance of the class with the specified settings. + + The object to initialize the ToolTipControllerEventArgsBase.SelectedControl property. + The object to initialize the ToolTipControllerEventArgsBase.SelectedObject property. + A value that specifies the tooltip’s text. This value is assigned to the ToolTipControllerShowEventArgs.ToolTip property. + A value that specifies the tooltip’s title. This value is assigned to the ToolTipControllerShowEventArgs.Title property. + A value that specifies the relative position of the tooltip window. This value is assigned to the ToolTipControllerShowEventArgs.ToolTipLocation property. + true if the callout beak is displayed when a hint appears; otherwise, false. This value is assigned to the ToolTipControllerShowEventArgs.ShowBeak property. + true if tooltip window’s corners are rounded; otherwise, false. This value is assigned to the ToolTipControllerShowEventArgs.Rounded property. + The radius of the rounded corners. This value is assigned to the ToolTipControllerShowEventArgs.RoundRadius property. + A value that specifies the kind of the predefined icon. This value is assigned to the ToolTipControllerShowEventArgs.IconType property. + A value that specifies the icon’s size. This value is assigned to the ToolTipControllerShowEventArgs.IconSize property. + An object that represents the source of the images that can be displayed within tooltips. This value is assigned to the ToolTipControllerShowEventArgs.ImageList property. + The index of the image to display in the tooltip. This value is assigned to the ToolTipControllerShowEventArgs.ImageIndex property. + An object that provides the tooltip’s appearance settings. This value is assigned to the ToolTipControllerShowEventArgs.Appearance property. + An object that provides the appearance settings used to paint the tooltip’s title. This value is assigned to the ToolTipControllerShowEventArgs.AppearanceTitle property. + + + + Initializes a new instance of the class with the specified settings. + + The object to initialize the ToolTipControllerEventArgsBase.SelectedControl property. + The object to initialize the ToolTipControllerEventArgsBase.SelectedObject property. + A value that specifies the tooltip’s text. This value is assigned to the ToolTipControllerShowEventArgs.ToolTip property. + A value that specifies the tooltip’s title. This value is assigned to the ToolTipControllerShowEventArgs.Title property. + A value that specifies the relative position of the tooltip window. This value is assigned to the ToolTipControllerShowEventArgs.ToolTipLocation property. + true if the callout beak is displayed when a hint appears; otherwise, false. This value is assigned to the ToolTipControllerShowEventArgs.ShowBeak property. + true if tooltip window’s corners are rounded; otherwise, false. This value is assigned to the ToolTipControllerShowEventArgs.Rounded property. + The radius of the rounded corners. This value is assigned to the ToolTipControllerShowEventArgs.RoundRadius property. + The regular tooltip’s style, which controls the look-and-feel settings. This value is assigned to the ToolTipControllerShowEventArgs.ToolTipStyle property. + A value that specifies the kind of the predefined icon. This value is assigned to the ToolTipControllerShowEventArgs.IconType property. + A value that specifies the icon’s size. This value is assigned to the ToolTipControllerShowEventArgs.IconSize property. + An object that is the source of the images that can be displayed within tooltips. This value is assigned to the ToolTipControllerShowEventArgs.ImageList property. + The index of the image to display in the tooltip. This value is assigned to the ToolTipControllerShowEventArgs.ImageIndex property. + An object that provides the tooltip’s appearance settings. This value is assigned to the ToolTipControllerShowEventArgs.Appearance property. + An object that provides the appearance settings used to paint the tooltip’s title. This value is assigned to the ToolTipControllerShowEventArgs.AppearanceTitle property. + + + + Creates an instance of the class and initializes the ToolTipControllerEventArgsBase.SelectedControl and ToolTipControllerEventArgsBase.SelectedObject properties. + + The object to initialize the ToolTipControllerEventArgsBase.SelectedControl property. + The object to initialize the ToolTipControllerEventArgsBase.SelectedObject property. + + + + Gets or sets whether HTML formatting tags can be used to format the tooltip’s text. + + A value that specifies whether HTML formatting tags can be used to format the tooltip’s text. + + + + Gets the tooltip’s appearance settings. This property is not in effect for objects. + + An object which provides the tooltip’s appearance settings. + + + + Gets the appearance settings used to paint the tooltip’s title. This property is not in effect for objects. + + An object which provides the appearance settings used to paint the tooltip’s title. + + + + Gets or sets whether the tooltip is hidden after a specific time ellapses. + + true if the tooltip is hidden after a specific time period ellapses; otherwise, false. + + + + Determines whether two objects are equal. + + The object specifying a instance to compare with the current object. + true if the specified object is equal to the current instance. + + + + Gets a control that should be shown within a flyout tooltip. + + A Control object. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + Gets the actual location of the tooltip window relative to the position where the tooltip should appear. + + A value specifying the relative position of the tooltip window. + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + Gets or sets the HTML template that should be used for this specific control. + + The active HTML template. + + + + Gets the size of the predefined icon to display in the tooltip. + + A enumeration value that specifies the icon size. + + + + Gets or sets the predefined icon to display in the tooltip. + + A enumeration value that specifies the predefined icon to display in the tooltip. + + + + Gets or sets the index of an image from the to display in the tooltip. + + The index of a custom image to display in the tooltip. + + + + Gets or sets the source of images that can be displayed within tooltips. + + An object that represents the source of images that can be displayed within tooltips. + + + + Provides access to options that specify the raster or vector image displayed in the processed tooltip. + + An object that specifies the image displayed in the processed tooltip. + + + + Gets or sets the bounds of the current object for which a tooltip is displayed. + + The bounds of the object for which a tooltip is displayed. + + + + Gets or sets whether a tooltip’s visual elements are aligned to support locales using right-to-left fonts. + + true if tooltip’s visual elements are aligned to support locales using right-to-left fonts; otherwise, false. + + + + Gets or sets whether the tooltip window has rounded corners. + + true if tooltip window’s corners are rounded; otherwise, false. + + + + Gets or sets the radius of the rounded corners of the tooltip window. + + The radius of the rounded corners. + + + + Gets or sets whether the tooltip should be displayed. + + true if the tooltip should be displayed; otherwise, false. + + + + Tests whether callout beaks are displayed for hints. + + true if the callout beak is displayed when a hint appears; otherwise, false + + + + Gets or sets a . + + A object. + + + + Gets or sets the regular tooltip’s title. + + A value which specifies the regular tooltip’s title. + + + + Gets or sets the text for the regular tooltip. + + The string that is the text to display in the regular tooltip. + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or relative to the editor. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether the tooltip is anchored relative to the mouse pointer or relative to the owning control. By Default, the behavior depends on the ToolTipController.ToolTipAnchor property and the owning control’s ToolTipAnchor setting. + + + + Gets or sets the image to display within the current tooltip. + + An object that specifies the image to display within the current tooltip. + + + + Gets or sets the space, in pixels, between the tooltip and the associated visual element. + + An integer value specifying the space, in pixels, between the tooltip and the associated visual element. The default is 16. + + + + Gets or sets the location of the tooltip window relative to the position where the tooltip should appear. + + A value specifying the relative position of the tooltip window. + + + + Gets or sets the look-and-feel settings of the regular tooltip displayed. + + A value that specifies the look-and-feel of regular tooltips. + + + + Gets or sets the type of tooltip to be displayed. + + A value that specifies the type of tooltip to be displayed. + + + + Enumerates values that specify the size of a predefined icon displayed within a tooltip. + + + + + A large icon. + + + + + + A small icon. + + + + + + Enumerates values that specify icon types to be displayed within tooltips. + + + + + A tooltip contains the default application icon. + + + + + A tooltip contains the system asterisk icon. + + + + + A tooltip contains the system error icon. + + + + + A tooltip contains the system exclamation icon. + + + + + A tooltip contains the system hand icon. + + + + + A tooltip contains the system information icon. + + + + + A tooltip contains no predefined icon. + + + + + A tooltip contains the system question icon. + + + + + A tooltip contains the system warning icon. + + + + + A tooltip contains the Windows logo icon. + + + + + Represents a region in a super tooltip. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether HTML formatting is allowed for the item’s text (ToolTipItem.Text). + + A value that specifies whether HTML formatting is allowed in the tooltip. + + + + Gets the default ToolTipItem.ImageToTextDistance property value. + + An integer value that is the default ToolTipItem.ImageToTextDistance property value. + + + + Releases all unmanaged resources used by the . + + + + + Gets or sets the font used to paint the item’s text. + + The font used to display the ‘s text (specified in the ToolTipItem.Text property). + + + + Gets or sets the icon displayed in the object. + + An System.Drawing.Icon that is displayed in the object. + + + + Gets or sets the image displayed in this tooltip region. + + An object that specifies an image displayed in this tooltip region. + + + + Gets or sets the image or icon alignment. + + The image or icon alignment. + + + + Gets or sets the index of the image in the collection. + + An integer value that specifies the index of the image in the collection. + + + + Provides access to properties that allow you to assign and customize an image for this tooltip item. + + A DevExpress.Utils.ToolTipItemImageOptions object that stores properties that allow you to assign and customize an image for this tooltip item. + + + + Gets or sets the collection of images that can be displayed in this tooltip region. + + An object that specifies the collection of images that can be displayed in this tooltip region. + + + + Gets or sets the distance between the image and text in this tooltip region. + + The distance, in pixels, between the image and text in this tooltip region. + + + + Gets whether the is empty. + + true if content (text, image and icon) is empty; otherwise, false + + + + Gets or sets the indent from the left edge of a . + + The indent from the left edge of a , in pixels. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether HTML tags can be used by the object (the owner). + + true to allow HTML tags in the object (the owner); otherwise, false. + + + + Gets or sets the tooltip item text. + + Specifies the text in a . + + + + Provides access to options that specify raster or vector image displayed in a super tooltip. + + + + + Initializes a new instance of the class. For internal use. + + + + + Gets or sets whether the image is aligned at the left or right edge of the tooltip. + + Default or Right if the image is aligned at the right; Left if the image is aligned at the left. + + + + Gets or sets the raster image. + + An object that specifies the raster image. + + + + Gets or sets the index of the image in the collection. + + An integer value that specifies the index of the image in the collection. + + + + Gets or sets the collection of images that can be displayed in the tooltip. + + An object that specifies the collection of images that can be displayed in the tooltip. + + + + Gets or sets the indentation of the text from the image. + + An integer value that specifies the indentation of the text from the image. + + + + Gets or sets the universal resource identifier of an image. + + An object that specifies a universal resource identifier of an image. + + + + Gets or sets the vector image. + + An object that specifies the vector image. + + + + Gets or sets the size of the vector image. + + A structures that specifies the vector image size. + + + + Specifies the location where a tooltip is displayed in relation to the mouse cursor position. + + + + + A tooltip appears vertically aligned at the bottom, and horizontally centered relative to the mouse cursor position. + + + + + + A tooltip appears vertically aligned at the bottom, and horizontally aligned on the left relative to the mouse cursor position. + + + + + + A tooltip appears vertically aligned at the bottom, and horizontally aligned on the right relative to the mouse cursor position. + + + + + + The default tooltip location. + + + + + A tooltip is shown in the location specified by the second parameter of the ShowHint(ToolTipControllerShowEventArgs, Point) overload. + + + + + A tooltip appears horizontally aligned on the left, and vertically aligned at the bottom relative to the mouse cursor position. + + + + + + A tooltip appears horizontally aligned on the left, and vertically centered relative to the mouse cursor position. + + + + + + A tooltip appears horizontally aligned on the left, and vertically aligned at the top relative to the mouse cursor position. + + + + + + A tooltip appears horizontally aligned on the right, and vertically aligned at the bottom relative to the mouse cursor position. + + + + + + A tooltip appears horizontally aligned on the right, and vertically centered relative to the mouse cursor position. + + + + + + A tooltip appears horizontally aligned on the right, and vertically aligned at the top relative to the mouse cursor position. + + + + + + A tooltip appears vertically aligned at the top, and horizontally centered relative to the mouse cursor position. + + + + + + A tooltip appears vertically aligned at the top, and horizontally aligned on the left relative to the mouse cursor position. + + + + + + A tooltip appears vertically aligned at the top, and horizontally aligned on the right relative to the mouse cursor position. + + + + + + Represents a separator in a super tooltip. + + + + + Initializes a new instance of the class. + + + + + Enumerates paint styles for tooltips. + + + + + The style of regular tooltips is automatically determined by the Windows OS and currently selected Windows theme. + In Windows Vista and Windows 7, if no classic Windows theme is applied, tooltips are painted using the ToolTipStyle.Windows7 style. + In other cases, tooltips are painted using the ToolTipStyle.WindowsXP style. + + + + + Regular tooltips are painted as those in Windows 7 (this style is in effect when a program runs under Windows Vista or Windows 7, provided that no classic Windows theme is applied). + + + + + + Regular tooltips are painted as those in Windows XP. + + + + + + Represents a title in a super tooltip. + + + + + Initializes a new instance of the class. + + + + + Enumerates tooltip types that are supported by controls. + + + + + The default tooltip type. The actual tooltip type is determined by a control. + + + + + A tooltip that allows you to display any control in the control. + + + + + A tooltip that utilizes the HTML template assigned to the controller’s HtmlTemplate property. + + + + + A regular tooltip that consists of the title and contents regions. + + + + + A that supports multiple text and image regions. + + + + + A scrollable context item. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the tick is displayed in the middle of the track and enables using a custom middle tick value. + + true if the tick is displayed in the middle of the track; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + Provides access to individual image-related property sets for every visual state. + + A DevExpress.Utils.ContextItemImageOptionsCollection object that stores image-related settings. + + + + Gets the maximum track value. + + An integer value that specifies the maximum track value. + + + + Gets or sets the value located in the middle of the track. + + An integer value located in the middle of the track. + + + + Gets the minimum track value. + + An integer value that specifies the minimum track value. + + + + Gets or sets whether the zoom buttons are displayed. + + true if the zoom buttons are displayed; otherwise, false. + + + + Gets or sets the value to be added to or subtracted from the TrackBarContextButton.Value property when one of the zoom buttons is clicked. + + An integer value to be added to or subtracted from the TrackBarContextButton.Value property when a zoom button is clicked. + + + + Gets or sets the length, in pixels, of the track. + + An integer value that specifies the length, in pixels, of the track. + + + + Gets or sets the track value. + + An integer value that specifies the track value. + + + + List values that specify how the characters in a string that do not completely fit into a layout shape are trimmed. + + + + + Specifies that the text is trimmed to the nearest character. + + + + + Trimming is determined by a control’s current settings. The default value is automatically set for a control if an end-user doesn’t specify a value. + + + + + Specifies that the text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line. + + + + + The center is removed from trimmed lines and replaced by an ellipsis. The algorithm keeps as much of the last slash-delimited segment of the line as possible. This mode is not supported if DirectX Hardware Acceleration is enabled. + + + + + Specifies that text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line. + + + + + Specifies no trimming. + + + + + Specifies that text is trimmed to the nearest word. + + + + + Contains controls that manage the visual effects of forms or other controls (e.g., the AdornerManager). + + + + + The base class for all adorner elements (e.g., s). + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to multiple sets of appearance settings, applied in different visual states. + + An DevExpress.Utils.VisualEffects.AdornerAppearanceCollection object that stores sets of appearance settings, applied in different visual states. + + + + Copies all settings from the target to this . + + An object whose settings are to be copied to this . + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Occurs when end-users clicks this . + + + + + Duplicates this . + + An Object that is this object’s copy. + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets whether the is being disposed of. + + true if the is being disposed of; otherwise, false. + + + + Provides access to a set of properties. + + An DevExpress.Utils.VisualEffects.AdornerElementDefaultProperties object that stores settings for this . + + + + Gets or sets the tab index for this . + + An Int32 value that is the tab index for this . + + + + Gets or sets any object associated with this . + + An Object that is the tag for this . + + + + Gets or sets the UI element to which this is bound. + + An Object related to this . + + + + Gets or sets whether this should be aligned relatively to the target element’s header or child control. + + A DevExpress.Utils.VisualEffects.TargetElementRegion enumeration value that specifies whether this should be aligned relatively to the target element’s header or child control. + + + + Gets or sets whether or not this is visible. + + true if this is visible; otherwise, false. + + + + Stores elements of the type. + + + + + Initializes a new instance of the class with the default settings. + + + + + Adds a specific to the current . + + An AdornerElement to be added to this . + + + + Adds multiple s to this . + + An IEnumerable structure containing s to be added. + + + + Fires when the is modified. + + + + + Checks whether or not this contains the target . + + The to be checked. + true if this contains the target ; otherwise, false. + + + + Copies all s from this to a target one-dimensional array, starting from the specific index of the target array. + + An AdornerElement[] array to which all items should be copied. + An Int32 value that is the index of the host array, starting from which copied elements should be arranged. + + + + Gets all elements of the specific type that are stored within this . + + A typed elements array. + + + + Gets all s related to the target UI element. + + An Object that is the source UI element, whose related adorner elements should be returned. + An AdornerElements array. + + + + Gets s of the specific type that are related to the target UI element. + + An Object that is the source UI element, whose related adorner elements should be returned. + A one-dimensional array containing elements of the specific type. + + + + Returns the object that iterates through the current . + + An IEnumerator object that iterates through this . + + + + Gets the current position of the target element within this . + + An whose index is to be obtained. + An Int32 value that is the current position of the target element within this . + + + + Gets or sets whether or not this can be modified. + + true if this is in read-only mode; otherwise, false. + + + + Gets the located at the target position within this . + + An Int32 value that is the element position within the . + An located at the target position within this . + + + + Removes the target from this . + + An AdornerElement to be removed. + true if the element was successfully removed; otherwise, false. + + + + The component that provides a transparent adorner layer for highlighting certain UI elements and/or displaying notifications for these elements. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An IContainer object that owns this newly created . + + + + Gets or sets whether or not end-users can cycle through selectable adorner elements (e.g., guides) by pressing arrow keys. + + true if end-users can use arrow keys to cycle through selectable adorner elements; otherwise, false. + + + + Gets or sets whether or not end-users can cycle through selectable adorner elements (e.g., guides) by pressing Tab. + + true if end-users can use the Tab key to cycle through selectable adorner elements; otherwise, false. + + + + Provides access to appearance settings common to all elements within this . + + An AppearanceObject that stores appearance settings common to all elements within this . + + + + Provides access to properties that affect all elements within this . + + A object that stores properties common to all elements within this . + + + + Locks the current and allows you to modify the control without immediately reflecting their changes. + + + + + Returns the HitInfo object for the target location. + + The HitInfo object for the target location. + The AdornerUIHitInfo object allows you to identify which UI elements are at the coordinates. + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Fires when a user clicks any element owned by this Adorner Manager. + + + + + Allows you to paint any manually. + + + + + Allows you to paint objects manually. + + + + + Allows you to paint objects manually. + + + + + Provides zero-based indexed access to s of any type owned by this . + + An object that stores all child objects for this . + + + + Unlocks the and forces it to repaint itself. + + + + + Provides access to four sets of appearance settings common to all objects owned by this manager. + + A DevExpress.Utils.VisualEffects.GuidesAppearances collection that stores sets of appearance settings, applied to guides in their corresponding visual states. + + + + Provides access to behavior settings common to all objects owned by this manager. + + A collection that stores behavior settings, applied to all guides owned by this manager. + + + + Hides all s owned by this . + + + + + Invalidates the region occupied by this . + + + + + Gets whether or not this has been locked for updating. + + true if this has been locked for updating; otherwise, false. + + + + Gets or sets the control that owns this . + + A ContainerControl that owns this . + + + + Occurs when a is activated and allows you to populate a flyout panel associated with this guide. + + + + + Redraws all elements. + + + + + Returns the currently selected adorner element. + + A currently selected . + + + + Occurs when a currently selected element changes. + + + + + Selects the specific element. + + An to be selected. + true if the specific element was successfully selected; otherwise, false. + + + + Activates the item within the AdornerUIManager.Elements collection that follows the currently selected item. + + + + + Activates the item within the AdornerUIManager.Elements collection that precedes the currently selected item. + + + + + Forces the to display all its child s whose visibility is currently set to true. + + + + + Gets or sets whether or not adorner guides should be displayed. + + A enumerator value that specifies whether or not adorner guides should be displayed. + + + + Updates the region occupied by this . + + + + + Provides access to three sets of appearance settings, applied to child objects in corresponding validation states. + + A DevExpress.Utils.VisualEffects.ValidationHintsAppearances collection that stores appearance setting for valid, invalid and indeterminate hint states. + + + + Provides access to behavior settings common to all objects owned by this manager. + + A collection that stores behavior settings, applied to all hints owned by this manager. + + + + A simple element within the . + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to the appearance settings that affect this . + + An object that stores appearance settings. + + + + Provides access to advanced settings. + + A object that stores advanced badge settings. + + + + Provides members that specify the appearance and behavior of the current . + + + + + Initializes a new instance of the class and inherits its property values from the parent object. + + A BadgeProperties object whose property values are copied to the newly created object. + + + + Gets the current image displayed by this badge. + + An Image, currently displayed by this badge. + + + + Returns the current stretch margins applied to this ‘s image. + + A Padding structure that is the current image stretch margins of this badge. + + + + Returns the current alignment relative to its target element. + + A enumerator value that specifies the current alignment relative to its target element. + + + + Returns the current offset. + + A Point structure that is the current offset. + + + + Returns the paint style currently applied to this badge. + + A DevExpress.Utils.VisualEffects.BadgePaintStyle enumerator value that is the paint style currently applied to this badge. + + + + Returns the text currently displayed in this badge. + + A String value that is the currently displayed badge text. + + + + Returns margins currently applied to this ‘s text. + + A Padding structure that specifies margins currently applied to this ‘s text. + + + + Gets whether or not this badge will be trimmed if it goes beyond its target element’s parent. + + true if the badge should be trimmed; otherwise, false. + + + + Gets or sets whether or not the glyph skinning feature is applied to this badge. + + A DefaultBoolean enumerator value that specifies whether or not the glyph skinning feature is applied to this badge. + + + + Gets or sets whether or not this badge recognizes HTML tags in its text. + + A enumerator value that specifies whether or not this badge recognizes HTML tags in its text. + + + + Gets or sets whether or not this badge should display its image. + + A enumerator value that specifies whether or not this badge should display its image. + + + + Returns whether or not this badge can recognize HTML tags in its caption string. + + true if this badge can recognize HTML tags in its caption string; otherwise, false. + + + + Gets whether or not this image can be stretched. + + true if this ‘s image can be stretched; otherwise, false. + + + + Gets whether or not an image, assigned to this will be displayed. + + true if an image, assigned to this will be displayed; otherwise, false. + + + + Gets or sets an image, used by this . + + An Image displayed within this badge. + + + + Provides access to settings that allow you to assign both raster and vector images to a badge. + + Provides access to badge image properties. + + + + Gets or sets the image region that can be stretched. + + A Padding structure that is the image stretch region. + + + + Gets whether or not this badge should colorize its glyph. + + true if this badge should colorize its glyph; otherwise, false. + + + + Gets or sets the relative position for this . + + A ContentAlignment enumerator value that specifies the relative position for this . + + + + Gets or sets this badge’s offset from its relative position. + + A Point structure that specifies this badge’s offset from its relative position. + + + + Gets or sets the paint style applied to this badge. + + A <DevExpress.Utils.VisualEffects.BadgePaintStyle,> enumerator value that specifies the paint style currently applied to this badge. + + + + Gets or sets whether or not this should stretch its image to fit the text block. + + A DefaultBoolean enumerator value that specifies whether or not this should stretch its image to fit the text block. + + + + Gets or sets the text string, displayed by this . + + A String value that is the text. + + + + Gets or sets margins for this ‘s text. + + A Padding structure that specifies margins for this ‘s text. + + + + Gets or sets whether or not this should be trimmed to match its target element’s parent. + + A DefaultBoolean enumerator value that specifies whether or not this badge should be trimmed to match its target element’s parent. + + + + Provides members that specify the appearance and behavior of all s within this adorner manager. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether or not all badges within this should colorize their images using background colors. + + true if all badges within this should colorize their images using background colors; otherwise, false. + + + + Gets or sets whether or not any badge owned by this manager should use HTML tags to format its caption string. + + true if any badge owned by this manager should use HTML tags to format its caption string; otherwise, false. + + + + Gets or sets whether or not badges within this should display their icons. + + true if badges within this should display their icons; otherwise, false. + + + + Gets or sets the default image, displayed by all badges within this . + + An Image object that is the default image, displayed by all badges within this . + + + + Gets or sets the image region that can be stretched. + + A Padding structure that is the image region that can be stretched. + + + + Gets or sets the URI that specifies an image from the DevExpress Image Gallery assigned to this badge. + + Specifies an image from the DevExpress Image Gallery assigned to this badge. + + + + Gets or sets the relative position, based on which all s within this are aligned. + + A ConenteAlignment enumerator value that specifies the relative position shared by all badges. + + + + Gets or sets the offset, common to all s within this . + + A Point structure that is the offset, common to all s within this . + + + + Gets or sets the paint style common to all badges owned by this manager. + + A DevExpress.Utils.VisualEffects.BadgePaintStyle enumerator value that specifies the paint style common to all badges owned by this manager. + + + + Gets or sets whether all badges should stretch their images according to the displayed text. + + true if all badges should stretch their images according to the displayed text; otherwise, false. + + + + Gets or sets the vector image assigned to a badge. + + The badge image. + + + + Gets or sets the size of the vector image assigned to a badge. + + The vector image size. + + + + Gets or sets the default text, displayed by all s within this . + + A String value that is the default text, displayed by all s within this . + + + + Gets or sets the global text margin, common to all s within this . + + A Padding structure that is the global text margin, common to all s within this . + + + + Gets or sets whether or not the should trim any that is bigger than its target element’s parent. + + true, to trim badges; otherwise, false. + + + + A child Adorner UI Manager element that highlights specific form regions. Provides a built-in flyout panel for displaying additional information and/or actions related to the highlighted region. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to a group of s that store appearance settings for this . + + A DevExpress.Utils.VisualEffects.GuideAppearances object that stores guide appearance settings. + + + + Provides access to the object that stores settings for this . + + A object that stores guide settings. + + + + Contains properties that affect invidual adorner guides only. + + + + + Initializes a new instance of the class with the specified settings. + + A object that stores global guide settings. These settings will be inherited by the newly created object. + + + + Returns the current flyout border thickness of an adorner guide. + + The flyout border thickness of an adorner guide. + + + + Returns the current flyout’s background color for this guide. + + A Color that is the current flyout’s background color for this guide. + + + + Returns the current flyout border color for this guide. + + A Color that is the current flyout border color for this guide. + + + + Returns the current flyout location for this guide. + + A enumeration value that is the current flyout location for this guide. + + + + Returns the current offset of a flyout panel associated with this adorner guide. + + The current flyout panel offset. + + + + Returns the current flyout opacity for this guide. + + A Double value that is the current flyout opacity for this guide. + + + + Gets or sets whether or not this guide should display its flyout panel. + + A enumerator value that specifies whether or not this guide should display its flyout panel. + + + + Gets or sets the flyout’s background color for the current guide. + + A Color applied to a flyout background of the current guide. + + + + Gets or sets the color applied to flyout borders of the current guide. + + A Color applied to flyout borders of this guide. + + + + Gets or sets the border thickness of a flyout panel associated with this adorner guide. + + The border thickness of a flyout panel. + + + + Gets or sets the flyout position relative to the current guide. + + A <,> enumerator value that specifies the flyout position relative to the current guide. + + + + Gets or sets the offset for a flyout panel displayed by this adorner guide. + + The flyout panel offset. + + + + Gets or sets the flyout opacity for this guide. + + A <,> value that is the flyout opacity for this guide. + + + + Returns whether or not this guide will show its flyout panel when selected. + + true if this guide will show its flyout panel when selected; otherwise, false. + + + + Provides flags that can be passed to the GuideDefaultProperties.FlyoutLocation and GuideProperties.FlyoutLocation properties to specify the flyout panel position relative to it’s parent adorner guides. + + + + + The flyout panel is displayed below its parent guide. + + + + + A default setting equal to the GuideFlyoutLocation.Bottom value. + + + + + The flyout panel is displayed to the left of its parent guide. + + + + + The flyout panel is displayed to the right of its parent guide. + + + + + The flyout panel is displayed above its parent guide. + + + + + Provides properties that affect all adorner guides owned by this Adorner UI Manager. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether any guide owned by this Adorner UI Manager can display flyout panels. + + true, to enable flyout panels for all guides; otherwise, false. + + + + Gets or sets the background flyout panel color for any guide owned by this Adorner UI Manager. + + A Color applied to the flyout panel background. + + + + Gets or sets the flyout panel border color for any guide owned by this Adorner UI Manager. + + + + + Gets or sets the border thickness of all flyout panels displayed by adorner guides. + + The border thickness of flyout panels. + + + + Gets or sets the flyout panel relative position for any guide owned by this Adorner UI Manager. + + + + + Gets or sets the offset for all flyout panels displayed by adorner guides. + + The flyout panel offset. + + + + Gets or sets the flyout panel opacity for any guide owned by this Adorner UI Manager. + + + + + Specifies whether guide flyouts should always stay within the current screen bounds. + + true if guide flyouts should always stay within the current screen bounds; false if guide flyouts can stretch beyond them. + + + + Gets or sets a keyboard shortcut that can be pressed at runtime to display guides. + + A enumerator value that is the keyboard shortcut that invokes guides. + + + + An object used by an Adorner UI Manager component to apply visual effects to controls based on these controls’ validation states. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to appearance settings for the current validation hint. + + A object that stores appearance settings for this hint. + + + + Provides access to base validation hint properties. + + A object that stores properties applied to this . + + + + Provides three property groups that store the appearance settings for all possible validation states of a target control, related to the object. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to appearance settings used by a when its target control is in the indeterminate state. + + An that stores appearance settings. + + + + Provides access to appearance settings used by a when its target control is in the invalid state. + + An that stores appearance settings. + + + + Provides access to appearance settings used by a when its target control is in the valid state. + + An that stores appearance settings. + + + + Provides access to base validation hint properties. Objects of this type affect individual validation hints only. + + + + + Initializes a new instance of the class with the specified settings. + + A object that stores base validation hint settings. These settings will be inherited by the newly created object. + + + + Returns which regions will be painted with this hint’s background color. + + A DevExpress.Utils.VisualEffects.ValidationHintBackgroundMode enumeration value. + + + + Returns the current text-to-border indent for this . + + An Int32 value that is the distance between a border and a hint of this object. + + + + Returns the current hint position for this object. + + A enumerator value that specifies the current hint position for this object. + + + + Returns the current hint padding for this object. + + A Padding structure applied to a hint of this object. + + + + Returns the icon currently displayed by this object’s hint. + + An Image currently displayed by this object’s hint. + + + + Returns the image-to-text indent for this object’s hint. + + An Int32 value that is the image-to-text indent for this object’s hint. + + + + Returns the predefined icon displayed within this object’s hint. + + A enumerator value that specifies which predefined icon is displayed within this object’s hint. + + + + Returns the unified resource identifier (URI) that specifies the image displayed by this object. + + A String value that is the URI of the displayed image. + + + + Returns the text currently displayed by this object’s hint. + + A String value that is the text currently displayed by this object’s hint. + + + + Gets or sets whether or not HTML tags in this object’s hint text should be used to format this text string. + + A enumerator value that specifies whether or not this should recognize HTML tags in its hint text. + + + + Gets or sets the indent between a border and a hint of this object. + + A <,> object that specifies the indent between a border and a hint of this object. + + + + Returns whether or not this object can format its hint text using HTML tags. + + true if the object can format its hint text using HTML tags; otherwise, false. + + + + Returns whether or not this object should display a border around its target UI element. + + true if this object should display a border; otherwise, false. + + + + Returns whether or not this object should display a hint next to its target UI element. + + true if this object should display a hint; otherwise, false. + + + + Returns whether or not this object can currently display a glyph within its hint. + + true if this object can currently display a glyph within its hint; otherwise, false. + + + + Gets or sets the alignment of this hint. + + Specifies the hint alignment. + + + + Gets or sets the position of this object’s hint relative to its target UI element. + + A enumeration value that specifies the relative hint position. + + + + Gets or sets the padding for this object’s hint. + + A Padding structure that is the padding for this object’s hint. + + + + Gets or sets the image displayed within this object’s hint. + + An Image object displayed within this object’s hint. + + + + Gets or sets the distance between text and image within a hint, displayed by this object. + + An Int32 value that is the distance between text and image within a hint, displayed by this object. + + + + Gets or sets one of the predefined images to be displayed within the object’s hint. + + A ValidationHintIconType enumeration value that specifies one of predefined images to be displayed within the object’s hint. + + + + Provides access to settings that allow you to assign raster and vector images to validation hints. + + Stores validation hint image settings. + + + + Gets or sets the image displayed within this object’s hint. The required image will be taken from the DevExpress Image Gallery. + + A String value that specifies the image displayed within this object’s hint. + + + + Gets or sets what object’s regions should be painted using this object’s background color. + + A <DevExpress.Utils.VisualEffects.ValidationHintBackgroundMode,> object that specifies what object’s regions should be painted using this object’s background color. + + + + Gets or sets whether or not this object should draw a border around its target UI element. + + A DefaultBoolean enumeration value that specifies whether or not this object should draw a border around its target UI element. + + + + Gets or sets whether or not this object should display a hint next to its target UI element. + + A DefaultBoolearn enumerator value that specifies whether or not this object should display a hint next to its target UI element. + + + + Gets or sets whether or not this should display a glyph within its hint. + + A enumerator value that specifies whether or not this should display a glyph within its hint. + + + + Gets or sets a text string displayed within this object’s hint. + + A String displayed within this object’s hint. + + + + Provides access to base validation hint properties. Objects of this type affect all validation hints owned by an Adorner UI Manager. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether or not any owned by this manager should recognize HTML tags in its hint text. + + true if objects should recognize HTML tags in their hint texts; otherwise, false. + + + + Gets or sets the indent between the object’s border and hint. This setting is common to all s owned by this manager. + + An Int32 value that is the indent between the object’s border and hint. + + + + Gets or sets the alignment of all validation hints owned by this Adorner Manager. + + The validation hint alignment. + + + + Gets or sets the relative hint position for any object owned by this Adorner UI Manager. + + A enumeration value that specifies the relative hint position for any object owned by this Adorner UI Manager. + + + + Gets or sets the padding. This setting affects all validation hints owned by this Adorner UI Manager. + + A Padding structure applied to all hints owned by this manager. + + + + Gets or sets the icon. This icon will be displayed for all validation hints owned by the Adorner UI Manager. + + An Image displayed by any validation hint owned by this manager. + + + + Gets or sets the indent between text and icon within a object’s hint. This setting is applied to all child validation hints for the current Adorner UI Manager. + + An Int32 value that is the default distance between hint text and image. + + + + Gets or sets one of predefined icons to be displayed within object hints. This setting affects all validation hints owned by this Adorner UI Manager. + + A enumerator value that specifies a default validation hint icon. + + + + Gets or sets the image displayed within a hint of any object owned by this manager. The required image will be taken from the DevExpress Image Gallery. + + A String value that specifies the image displayed within a hint of any object owned by this manager. + + + + Gets or sets elements that will be colorized using the background color. This setting is applied to all objects owned by this manager. + + A DevExpress.Utils.VisualEffects.ValidationHintBackgroundMode enumerator value that specifies elements that will be colorized using the background color. + + + + Gets or sets whether or not any object owned by this Adorner UI Manager should display borders around its target UI element. + + true if validation hints should display borders; otherwise, false. + + + + Gets or sets whether or not any object owned by this Adorner UI Manager should display hints next to its target UI element. + + true if validation hints should display hints; otherwise, false. + + + + Gets or sets whether or not a should display a glyph within its hint. This setting is applied to all validation hints owned by this manager. + + true if a should display a glyph within its hint; otherwise, false. + + + + Gets or sets a vector images assigned to a validation hint. + + The vector image assigned to a hint. + + + + Gets or sets the size of vector images assigned to validation hints. + + The vector image size. + + + + Gets or sets the default text. + + A String value that is the default validation hint text. + + + + An object that stores individual validation hint properties for all three control validation states. + + + + + Initializes a new instance of the class with the specified settings. + + A ValidationHintProperties object whose settings should be inherited by the newly created object. + + + + Returns the current validation state of this object. + + A DevExpress.Utils.VisualEffects.ValidationHintState enumerator value that returns the current validation state. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Provides access to the behavior settings applied when its target UI element is not yet validated. + + A object that stores behavior settings applied when the target UI element that is yet to be validated. + + + + Provides access to the behavior settings applied when its target UI element fails validation. + + A object that stores behavior settings applied when the target UI element fails validation. + + + + Gets or sets the current validation state of this . + + A ValidationHintState enumerator value that is the current validation state of this . + + + + Provides access to the behavior settings applied when its target UI element successfully passes validation. + + A object that stores behavior settings applied when the target UI element passes validation. + + + + This enumeration’s values can be passed to the ValidationHintBaseDefaultProperties.IconType and ValidationHintBaseProperties.IconType properties to choose a predefined image for individual or all objects. + + + + + An application icon. + + + + + An error icon. + + + + + An information icon. + + + + + A will not display any icon. + + + + + A question icon. + + + + + A warning icon. + + + + + Provides flags that can be passed to the ValidationHintBaseDefaultProperties.HintLocation and ValidationHintBaseProperties.HintLocation properties to set hint locations relative to their parent objects. + + + + + The hint will be displayed below the target UI element. + + + + + A default location. This value is equal to ValidationHintLocation.Bottom. + + + + + The hint will be displayed to the target UI element’s left. + + + + + The hint will be displayed to the target UI element’s right. + + + + + The hint will be displayed above the target UI element. + + + + + An object that stores global validation hint properties for all three control validation states. + + + + + Initializes a new instance of the class with the default settings. + + + + + Provides access to settings that will be in effect only when the parent is in the indeterminate state. + + A object that stores settings for the indeterminate object state. + + + + Provides access to settings that will be in effect only when the parent is in the invalid state. + + A object that stores settings for the invalid object state. + + + + Gets or sets this object’s current state. + + A DevExpress.Utils.VisualEffects.ValidationHintState enumerator value that specifies this object’s current state. + + + + Provides access to settings that will be in effect only when the parent is in the valid state. + + A object that stores settings for the valid object state. + + + + Contains classes supporting the functionality of the . + + + + + Contains values that specify the position at which a is displayed relative to its owner. + + + + + The panel, when displayed, is stretched along the owner’s bottom edge. + + + + + The panel is displayed at the center of the owner. The display size is specified by the panel’s Size property. + + + + + The panel, when displayed, is stretched along the owner’s left edge. + + + + + The panel is displayed at the position specified by the FlyoutPanelOptions.Location property. + + + + + The panel, when displayed, is stretched along the owner’s right edge. + + + + + The panel, when displayed, is stretched along the owner’s top edge. + + + + + The panel is displayed at the owner’s top left corner in the original size specified by the Size property. When using the PopupToolWindowAnimation.Slide animation effect, the panel slides from top to bottom. + Use the FlyoutPanelOptions.HorzIndent and FlyoutPanelOptions.VertIndent properties to shift the display position inward from the top left corner. + + + + + The panel is displayed at the owner’s top right corner in the original size specified by the Size property. When using the PopupToolWindowAnimation.Slide animation effect, the panel slides from top to bottom. + Use the FlyoutPanelOptions.HorzIndent and FlyoutPanelOptions.VertIndent properties to shift the display position inward from the top right corner. + + + + + Enumerates animation modes. + + + + + A fade animation effect. + + + + + A slide-in animation effect. + + + + + Provides arguments for the , , , , and events. + + + + + Initializes a new WorkspaceEventArgs class instance. + + An IWorkspace object that specifies the processed workspace. This parameter is assigned to the property. + + + + Gets or sets a unique ID for the current workspace. + + Any Object that serves as a unique workspace ID. + + + + Gets the processed workspace. + + An IWorkspace object that specifies the processed workspace. + + + + Manages layouts of all DevExpress controls in the application as one global workspace. Workspaces can be saved and restored to (from) a local storage or stream. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + An IContainer that is the target control of the newly created object. + + + + Occurs after a workspace was applied. + + + + + Gets or sets whether or not changing workspaces within this should be followed by animation effects. + + A DefaultBoolean enumerator value that specifies whether or not changing workspaces within this should be followed by animation effects. + + + + Locates a workspace with the target name within the WorkspaceManager.Workspaces collection and applies it to the application. + + A String value that is the workspace name within the WorkspaceManager.Workspaces collection. + + + + Fires before the Workspace Manager applies a new workspace. + + + + + Captures the current form layout and places it to the WorkspaceManager.Workspaces collection under the specific name. + + A String value that is the name of the captured workspaces. + true if the workspace should include the layout of child controls hosted within controls on the current form (user control); otherwise, false. + + + + Gets or sets whether this should automatically close streams opened when loading workspaces. + + A DefaultBoolean enumerator value that specifies whether this should automatically close streams opened when loading workspaces. + + + + Gets or sets whether this should automatically close streams opened when saving workspaces. + + A DefaultBoolean enumerator value that specifies whether this should automatically close streams opened when saving workspaces. + + + + Gets a stored within the target control. + + A Control from which a is extracted. + A stored within the target control. + + + + Returns a workspace with a specific index from the WorkspaceManager.Workspaces collection. + + An Int32 value that is the index of a workspace to be obtained. + An IWorkspace object that is the workspace with the target index. + + + + Returns a workspace with a specific name from the WorkspaceManager.Workspaces collection. + + A String value that is the name of a workspace to be obtained. + An IWorkspace object that is the workspace with the target name. + + + + Loads a workspace from the target stream and places this workspace in the WorkspaceManager.Workspaces collection under the specific name. + + A String value that is the name this workspace will have in the WorkspaceManager.Workspaces collection. + A Stream that contains the desired workspace. + true if the workspace name written in a stream has a priority over the name parameter of this method; otherwise, false. + true if the workspace was successfully loaded; otherwise, false. + + + + Loads a workspace from the target stream and places it in the WorkspaceManager.Workspaces collection under the specific name. + + A String value that is the name of the loaded workspace within the WorkspaceManager.Workspaces collection. + A Stream that contains the required workspace. + true if the workspace was successfully loaded; otherwise, false. + + + + Loads a workspace from the target file and places this workspace in the WorkspaceManager.Workspaces collection under the specific name. + + A String value that is the name this workspace will have in the WorkspaceManager.Workspaces collection. + A String value that is the path to a local storage file, which contains the required workspace. + true if the workspace name written in a file has a priority over the name parameter of this method; otherwise, false. + true if the workspace was successfully loaded; otherwise, false. + + + + Loads a workspace from the target local file and places it in the WorkspaceManager.Workspaces collection under the specific name. + + A String value that is the name under which the loaded workspace is kept in the WorkspaceManager.Workspaces collection. + An Object that is the location of the file that stores a workspace. + true if the workspace was successfully loaded; otherwise, false. + + + + Loads all workspaces in the target stream into the WorkspaceManager.Workspaces collection. + + A Stream that stores workspaces to be loaded. + + + + Loads all workspaces in the target file into the WorkspaceManager.Workspaces collection. + + A String value that specifies the path to a file that stores workspaces. + + + + Occurs whenever a property is about to be restored from a workspace. + + + + + Occurs whenever a property is about to be written into a workspace. + + + + + Provides access to the recently used workspaces collection. + + A List object containing the recently used workspaces collection. + + + + Removes a workspace with the target name from the WorkspaceManager.Workspaces collection. + + A String value that is the name under which the workspace is stored within the WorkspaceManager.Workspaces collection. + + + + Renames the target workspace. + + A String value that is the name under which the workspace is currently stored in the WorkspaceManager.Workspaces collection. + A String value that is the new name for the workspace. + + + + Loads the layouts of specified controls from a stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A collection of controls whose layouts are to be loaded. + A Stream with layouts of specified controls. + The method that defines a set of criteria and allows you to filter deserialized properties. + + + + Loads the layouts of specified controls from a file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A collection of controls whose layouts are to be loaded. + The path to a file that stores the layout. + The method that defines a set of criteria and allows you to filter deserialized properties. + + + + Loads the layout of the specified control from a stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A control whose layout is to be loaded. + A Stream with the control’s layout. + The method that defines a set of criteria and allows you to filter deserialized properties. + + + + Loads the layout of the specified control from a file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A control whose layout is to be loaded. + The path to a file that stores layouts of controls. + The method that defines a set of criteria and allows you to filter deserialized properties. + + + + Saves the layouts of specified controls to a stream. + + A collection of controls whose layouts are to be saved. + A Stream with layouts of specified controls. + The method that defines a set of criteria and allows you to filter serialized properties. + + + + Saves the layouts of specified controls to a file. + + A collection of controls whose layouts are to be saved. + The path to a file that stores layouts of controls. + The method that defines a set of criteria and allows you to filter serialized properties. + + + + Saves the layout of the specified control to a stream. + + A control whose layout is to be saved. + A Stream with the control’s layout. + The method that defines a set of criteria and allows you to filter serialized properties. + + + + Saves the layout of the specified control to a file. + + A control whose layout is to be saved. + The path to a file that stores the control’s layout. + The method that defines a set of criteria and allows you to filter serialized properties. + + + + Gets or sets whether the should store settings like “Bounds” or “State” for the form assigned to the WorkspaceManager.TargetControl property. + + true if the should save parent form settings; otherwise, false. + + + + Saves a workspace from the WorkspaceManager.Workspaces collection to a stream. + + The name of the target workspace in the WorkspaceManager.Workspaces collection. + The stream to which the target workspace is to be saved. + true to capture and then save the current controls’ layouts to a stream if the WorkspaceManager.Workspaces collection does not contain a workspace with the specified name.false to interrupt the workspace saving if the WorkspaceManager.Workspaces collection does not contain a workspace with the specified name. + true if the workspace was successfully saved; otherwise, false. + + + + Saves a workspace from the WorkspaceManager.Workspaces collection to a local file. + + The name of the target workspace in the WorkspaceManager.Workspaces collection. + The path to which the target workspace is to be saved. + true to capture and then save the current controls’ layouts to a file if the WorkspaceManager.Workspaces collection does not contain a workspace with the specified name.false to interrupt the workspace saving if the WorkspaceManager.Workspaces collection does not contain a workspace with the specified name. + true if saving was successful; otherwise, false. + + + + Saves all workspaces in the WorkspaceManager.Workspaces collection to the target stream. + + A Stream to which workspaces should be saved. + + + + Saves all workspaces in the WorkspaceManager.Workspaces collection to the target file. + + A String value that specifies the path to a file. + + + + Allows you to exclude a specific control from the global application workspace. + + A Component that is the target control. + false to force the WorkspaceManager to ignore the target control; otherwise, true. + true to ingore child controls of the target control; otherwise, false. + + + + Gets or sets whether the “Workspaces” dialog should display the column that shows paths to workspace files. + + true if the “Workspaces” dialog should display the column that shows paths to workspace files; otherwise, false. + + + + Gets or sets a control whose layout is managed by this . + + A Control whose layout is managed by this . + + + + Gets or sets whether the application should throw the when a user attempts to apply a corrupt workspace. Regardless of this setting, the Workspace Manager also fires the WorkspaceError event that notifies you about the issue. + + Specifies whether or not invalid workspaces should trigger the when applied. The Default value is equal to False. + + + + Gets or sets the transition animation that follows applying workspaces. + + An ITransitionAnimator object that is the transition animation with its parameters. + + + + Occurs whenever a new workspace was added to the WorkspaceManager.Workspaces collection. + + + + + Occurs whenever the WorkspaceManager.Workspaces collection of the current Workspace Manager component changes. + + + + + Occurs when a corrupt workspace is activated. Allows you to read the “args” parameter to identify the issue found in this layout. This event is followed by the if the WorkspaceManager.ThrowOnWorkspaceError property is enabled. + + + + + Fires when a workspace was removed from the WorkspaceManager.Workspaces collection. + + + + + Provides access to all currently active workspaces. + + A List structure that stores all currently active workspaces. + + + + Occurs after the WorkspaceManager.SaveWorkspace method was called. + + + + + Contains values specifying whether bound controls is drawn using XP style. + + + + + If bound control can display or edit data using inplace editors, latter are painted in the same style as its container. Otherwise it is drawn in XP style, if it is supported by a user’s system. + + + + + An editor is drawn in Windows Classic style. + + + + + An editor is drawn in XP style if it is supported by user’s system. + + + + + Contains classes that are used to emulate the UI found in Visual Studio 2010. + + + + + Provides members that specify whether a button is a regular (push button) or check-button. + + + + + Specifies whether a custom header button is a check or a group radio button. + + + + + Specifies a custom header button is a regular (push) button. + + + + + Contains editor classes that implement the functionality for corresponding controls. + + + + + Contains classes that provide the base button functionality. + + + + + Contains properties for objects. + + + + + Provides access to the current object’s appearance settings. + + An AppearanceObject that stores the current IButton object’s appearance settings. + + + + Locks the by preventing visual updates of the object and its elements until the EndUpdate method is called. + + + + + Unlocks the object and its elements without immediate visual update. + + + + + Gets or sets the current object’s caption. + + A String value that is the current IButton object’s caption. + + + + Gets or sets if the current is checked. + + A Boolean value specifying whether the current IButton is checked. + + + + Gets or sets whether the current object is enabled. + + true if the current object is enabled; otherwise, false. + + + + Unlocks an causing immediate visual update of the object and all its elements. + + + + + Gets or sets a collection of glyphs for the current object. + + An Object that is the glyphs collection for the current IButton object. + + + + Gets or sets a group index for the current object. + + An Int32 value that is the group index for the current IButton object. The default value is -1. + + + + Gets or sets the current object’s icon. + + An Image object that is the current IButton object’s icon. + + + + Gets or sets an IButtonProperties.Images collection member used as the current object’s glyph. + + An Int32 value that points to an IButtonProperties.Images collection member used as the current object’s glyph. + + + + Gets or sets the current object’s icon location relative to its IButtonProperties.Caption. + + An ImageLocation enumerator value specifying the current IButton object’s icon location relative to its IButtonProperties.Caption. + + + + Provides access to all properties that allow you to assign and customize an icon for this . + + A DevExpress.XtraEditors.ButtonPanel.BaseButtonImageOptions object that stores all properties that allow you to assign and customize an icon for this . + + + + Gets a collection of images that can be used as the current object’s icon. + + The Object that is the source of images assigned to the parent dock panel’s DockPanel.Images property. + + + + Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the button. + A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). + + A string value that specifies the uniform resource identifier of the image to be displayed in the button. + + + + Gets whether the current is locked for any visual update. + + true if the current is locked for any visual update; otherwise, false. + + + + Gets or sets the current object’s type. + + A ButtonStyle enumerator value that specifies the current IButton object’s type. + + + + Gets or sets a super tool-tip for the current . + + A object associated with the current . + + + + Gets or sets the current object’s tag. + + An Object that is the current IButton object’s tag. + + + + Gets or sets a tool-tip for the current . + + A String value that is the current ‘s tool-tip. + + + + Gets or sets whether the current object’s IButtonProperties.Caption is visible. + + true if the current object’s IButtonProperties.Caption is visible; otherwise, false. + + + + Gets or sets whether the current object’s icon is visible. + + true if the current object’s icon is visible; otherwise, false. + + + + Gets or sets whether the current object is visible. + + true if the current object is visible; otherwise, false. + + + + Gets or sets the current object’s relative position. + + An Int32 value specifying the current IButton object’s relative position. + + + + Contains values that specify whether Data Grid and Tree List columns should display Excel-style or classic filter menus. + + + + + Grid and TreeList columns display classic drop-down filter menus. + + + + + Equivalent to the ColumnFilterPopupMode.Excel setting. + + + + + Grid and TreeList columns display Excel-style filter menus. + + + + + Contains classes that provide editor functionality and specify editor appearance. + + + + + Contains values specifying border sides. + + + + + All border sides are painted. Enabling this flag results in enabling the Left, Top, Right and Bottom flags and disabling the None flag. + + + + + Bottom border side is painted. + + + + + Left border side is painted. + + + + + None of border sides is painted. Enabling this option results in disabling all other options. + + + + + Right border side is painted. + + + + + Top border side is painted. + + + + + Enumerates border and button styles for editors. + + + + + The default border style depends on the application skin. + + + + + Deprecated. Borders are flat. + + + + + + Deprecated. Flat border. The border and the client area are highlighted when the cursor hovers the editor. + + + + + + + No border. + + + + + + Deprecated. Office 2003-style border. + + + + + + Flat border. + + + + + + Deprecated. Three-dimensional border. + + + + + + Deprecated. Flat border in the Office XP style. Border and the client area are highlighted when the mouse pointer hovers the editor; otherwise, no border. + + + + + + + Specifies the surface image of a button. + + + + + A Clear symbol is drawn on the button’s surface. + + + + + + A Close symbol is displayed on the button’s surface. + + + + + + A Down-arrow for a combo box is drawn on the button’s surface. + + + + + + A Delete symbol is drawn on the button’s surface. + + + + + + A Down-arrow is drawn on the button’s surface. + + + + + + A Down-arrow is drawn on the button’s surface. Unlike, the Down button, this kind of button allows text to be displayed next to the down-arrow. + + + + + + An Ellipsis symbol is drawn on the button’s surface. + + + + + + A custom bitmap is drawn on the button’s surface. + + + + + A Left-arrow symbol is drawn on the button’s surface. + + + + + + A Minus sign is drawn on the button’s surface. + + + + + + An OK sign is drawn on the button’s surface. + + + + + + A Plus sign is drawn on the button’s surface. + + + + + + A Redo symbol is drawn on the button’s surface. + + + + + + A Right-arrow is drawn the button’s surface. + + + + + + A Search symbol is drawn on the button’s surface. + + + + + + A Separator. + + + + + + A down-arrow for a spin editor is displayed on the button’s surface. + + + + + + A left-arrow for a spin editor is displayed on the button’s surface. + + + + + + A right-arrow for a spin editor is displayed on the button’s surface. + + + + + + An up-arrow for a spin editor is displayed on the button’s surface. + + + + + + An Undo symbol is drawn on the button’s surface. + + + + + + An Up-arrow is drawn on the button’s surface. + + + + + + Specifies the state of an . + + + + + A button is highlighted when mouse crosses the entire button boundaries. + + + + + A button is disabled and does not respond to end-user actions. + + + + + A button is highlighted when the mouse enters its boundaries. + + + + + A button is drawn using its default look and feel. + + + + + A button is drawn to reflect a pressed state. + + + + + Contains values specifying the look of the check box within a control. + + + + + A radio button (the appearance depends on the control’s look-and-feel): + In the Skin, Office 2003 and WindowsXP paint schemes, the Indeterminate and Unchecked check styles look the same. + + + + + The default mode (the appearance depends on the control’s look-and-feel) : + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Predefined custom style. + + + + + Allows you to customize the check box glyph using the RepositoryItemCheckEdit.ImageOptions property. + + + + + Contains check box paint styles applied in the indeterminate state. + + + + + A check box is drawn grayed. In skin paint themes, the Inactive option is equivalent to InactiveChecked. + + + + + A check box is drawn grayed. An additional gray tick mark is displayed in the Flat, UltraFlat and Style3D paint themes. + + + + + A check box is drawn unchecked. + + + + + Exposes core properties. + + + + + Initializes a new instance of the class. + + + + + Adds the target control to this DirectXForm. + + The control to be owned by this DirectXForm. + + + + Gets or sets whether users can drag-and-drop the form’s title bar to move this form. + + true, if users are allowed to move this form; otherwise, false. + + + + Returns the client area container that hosts form’s child controls. + + The client area container of this form. + + + + Gets or sets whether the DirectX Hardware Acceleration should be enabled for this form and its child controls. + + Specifies whether this form should utilize the DirectX Hardware Accelleration. The DefaultBoolean.Default value is equivalent to DefaultBoolean.True. + + + + Occurs when a user clicks any element within an HTML template. + + + + + Occurs when a mouse button is pressed, and the mouse pointer is over an HTML element. + + + + + Occurs when a mouse pointer moves while over an element of an HTML-CSS template. + + + + + Occurs when a mouse pointer leaves the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse pointer enters the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse button pressed over an element of an HTML-CSS template is released. + + + + + Gets or sets the collection of images that elements of an HTML template can use. + + The collection of images used by HTML template elements. + + + + Returns an HTML Template for this form. + + An HTML template for this form. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the form is redrawn. + + + + + Lists modes that specify the Expression Editor version. + + + + + Specifies a new version of the Expression editor. + + + + + Editor version depends on the WindowsFormsSettings.DefaultSettingsCompatibilityMode value. If its value is v16 or less, it is the legacy version; otherwise, the new version is used. + + + + + Specifies a legacy version of the Expression editor. + + + + + Enumerates display styles of filter criteria in a control’s Filter Panel, MRU Filter List, and Filter Editor. + + + + + When a control’s FilterCriteriaDisplayStyle property is set to Default, the actual display style is specified by the WindowsFormsSettings.FilterCriteriaDisplayStyle property. + For the Report Designer and Dashboard Designer, the default display style is Visual. + For other controls, the default display style is Visual starting from v21.1; in older versions, the default display style is Text. + + + + + Renders filter criteria in a text-based format. + + + + + + Renders filter criteria in an easy-to-read format and uses skin-based colored highlights to differentiate between column names, functions, and values. In the Filter Panel, the ‘x’ button is displayed when you hover over a condition. This button allows users to remove individual conditions from the filter. + + + + + + Enumerates values that specify whether the find panel displays the found records only or displays all records and highlights the found records. + + + + + The behavior depends on the static (Shared in VB) WindowsFormsSettings.FindPanelBehavior property. If the latter property is also set to , the mode is applied. + + + + + Hide records that do not match a query. Highlight search results in cells. + + + + + + Highlight search results in cells and on the scrollbar. A search behavior is not supported in server mode. + + + + + + Enumerates border effects for forms and dialogs. + + + + + The default border adorning effect, applied as follows: + For the , a shadow is displayed in the “McSkin” skin. No adorning effect is applied in other skins. + For the , a shadow is displayed in the following skins: “Office 2013”, “Office 2013 Dark Gray”, “Office 2013 Light Gray”, and “McSkin”. No adorning effect is applied in other skins. + + + + + A glow effect. The default colors can be changed via the XtraForm.ActiveGlowColor and XtraForm.InactiveGlowColor properties. + + + + + No adorning effect. + + + + + Displays a shadow around the form. + + + + + Supplies data for the GroupControl.CustomDrawCaption event. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the Cache property. + An DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the Painter property. + A DevExpress.Utils.Drawing.ObjectInfoArgs object that contains information about the element being painted. This value is assigned to the GroupCaptionCustomDrawEventArgs.Info property. + + + + Initializes a new instance of the class with the specified settings. + + A GroupCaptionCustomDrawEventArgs object whose settings should be copied. + + + + Gets the painted caption’s bounding rectangle. + + A structure which represents the painted caption’s bounding rectangle. + + + + Performs default painting of the control’s caption background. + + + + + Performs default painting of the buttons embedded in the control’s caption. + + + + + Performs default painting of the control’s caption image. + + + + + Performs default painting of the text in the control’s caption. + + + + + Gets information on the painted group. + + A DevExpress.Utils.Drawing.GroupObjectInfoArgs object which provides information about the painted group. + + + + A method that handles the GroupControl.CustomDrawCaption event. + + The event source. This parameter identifies the group control that raised the event. + A object that contains event data. + + + + The panel with a title which can be aligned along the top, bottom, left or right edge. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether to colorize the group caption and border with the BorderColor setting in skinning paint schemes. This property is ignored by default starting from v18.2. + + true, to apply a custom color to the group control’s border and caption background in skinning paint schemes; otherwise, false. + + + + Gets or sets whether an image within the ‘s caption should be painted using the control’s foreground color. + + true if an image within the ‘s caption should be painted using the control’s foreground color; otherwise, false. + + + + Gets or sets whether HTML tags can be used to format the control’s GroupControl.Text. + + true if HTML tags can be used to format the control’s GroupControl.Text; otherwise, false. + + + + Gets the appearance settings used to paint the group’s caption and border. + + The group control’s caption and border appearance settings. + + + + Gets or sets the distance, in pixels, between GroupControl.CustomHeaderButtons. + + An integer value that specifies the distance, in pixels, between GroupControl.CustomHeaderButtons. + + + + Gets or sets the image to display within the group’s caption area. + + A object that specifies the group’s caption image. + + + + Gets or sets the relative position of an image within the group caption. + + A value that specifies the image’s position. + + + + Provides access to properties that affect this ‘s caption image. + + A DevExpress.XtraEditors.GroupCaptionImageOptions object that stores properties that affect this ‘s caption image. + + + + Gets or sets the outer indents for the image within the group caption, in pixels. + + A System.Windows.Forms.Padding object that specifies padding information for the image. + + + + Gets or sets the uniform resource identifier (URI) that specifies the image assigned for this . + + A DevExpress.Utils.DxImageUri object that is the uniform resource identifier (URI) for this . + + + + Gets or sets the location of the group control’s caption. + + A enumeration member which specifies the group caption’s location. + + + + Occurs whenever a check button from the GroupControl.CustomHeaderButtons collection is checked. + + + + + Occurs whenever a push button from the GroupControl.CustomHeaderButtons collection is clicked. + + + + + Occurs whenever a check button from the GroupControl.CustomHeaderButtons collection is unchecked. + + + + + Allows you to custom paint the caption region. + + + + + Allows you to custom paint header buttons (GroupControl.CustomHeaderButtons). + + + + + Specifies a collection of custom header buttons. + + A descendant that stores custom header buttons for this . + + + + Gets or sets the position of GroupControl.CustomHeaderButtons. + + A enumerator value that specifies the position of GroupControl.CustomHeaderButtons within this . + + + + Gets the bounds of the control’s client region. + + A structure which represents the bounding rectangle of the control’s client region. + + + + Retrieves detailed information about a tool-tip located at the specific position. + + A Point structure to check whether it belongs to a tool-tip. Coordinates are referenced from the ‘s top left corner. + A ToolTipControlInfo object that stores the tool-tip’s information. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Gets or sets the style of this ‘s borders and header. + + A DevExpress.Utils.GroupStyle object enumeration value that specifies the style of this ‘s borders and header. + + + + Gets or sets a collection of images that can be inserted into the control’s caption (GroupControl.Text) using the image tag. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Occurs each time a user clicks a hyperlink within the control’s caption. + + + + + Gets or sets a collection that stores caption images. + + An Object that stores caption images. + + + + Invalidates the entire surface of the control and causes the control to be redrawn. + + + + + Gets or sets whether the group’s caption is displayed. + + true to display the group’s caption; otherwise, false. + + + + Gets or sets the ‘s text. + + A string that specifies the control’s text. + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of tooltips displayed by custom header buttons. + + A object which controls the appearance and behavior of tooltips displayed by custom header buttons. + + + + The horizontal scrollbar. + + + + + Creates a new object. + + + + + Serves as the base for the class. + + + + + Gets the value indicating whether the scroll bar is horizontal or vertical. + + A enumeration member specifying the scroll bar’s orientation. + + + + Supplies data for events that allow you to draw visual elements manually. + + + + + Initializes a new instance of the class with specified settings. + + An object that provides access to the drawing surface and a cache of pens, fonts, and brushes. + An object that performs paint operations. + An object that contains information about the visual element being drawn. + + + + Provides access to the drawing surface and a cache of pens, fonts, and brushes. + + An object that provides access to the drawing surface and a cache of pens, fonts, and brushes. + + + + Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements. + + A template to draw. + The object that transfers mouse events from a control to a template instance. This allows you to switch visual states (regular, hovered, pressed, and others) of template elements. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Paints the required HTML template inside an element that raised this event. + + A template to draw. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Provides access to the drawing surface. + + An object that provides access to the drawing surface. + + + + Gets or sets whether the event is handled and prevents the default draw operation from being performed. + + true, to prevent the default draw operation from being performed; otherwise, false. + + + + Provides access to the object that contains information about the visual element being drawn. + + An object that contains information about the visual element being drawn. + + + + Provides access to the object that performs paint operations. + + An object that performs paint operations. + + + + The panel with or without a border. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets the appearance settings used to paint the panel. + + An object which contains the panel’s appearance settings. + + + + Not supported. + + A Boolean value. + + + + Not supported. + + A object that represents the height and width of the auto-scroll margin, in pixels. + + + + Not supported. + + A object that represents the minimum height and width of the control’s scrollbars, in pixels. + + + + Gets or sets the panel’s background color. + + A structure which specifies the panel’s background color. + + + + Gets or sets the control’s background image. This member is not supported by the class. Use the Appearance.Image property instead. + + A object. + + + + This member is not supported by the class. + + An value that specifies the position of an image on the control. + + + + Starts the panel’s initialization. Initialization occurs at runtime. + + + + + Gets or sets the panel’s border style. + + A enumeration value that specifies the panel’s border style. + + + + Returns the panel’s bounding rectangle, calculated from the bounds of its client region. + + A object. + A structure which represents the bounding rectangle of the panel’s client region. + A structure which represents the panel’s bounding rectangle, calculated from the bounds of its client region. + + + + Gets or sets the group’s background image that is displayed “as is”, and can be aligned to any panel’s edge. + + An object. + + + + Gets or sets the content image’s alignment within the panel. + + A value that specifies the content image’s alignment. + + + + Gets or sets the content image’s alignment within the panel. + + A value that specifies the content image’s alignment. + + + + Gets the bounds of the panel’s client region. + + A structure which represents the bounding rectangle of the panel’s client region. + + + + Ends the ‘s initialization. + + + + + Gets or sets the panel’s font. + + A object which specifies the panel’s font. + + + + Gets or sets the panel’s foreground color. + + A structure which specifies the panel’s foreground color. + + + + Resets the PanelControl.BackColor property back to its default value. + + + + + Resets the PanelControl.ForeColor property back to its default value. + + + + + Gets or sets the text associated with the panel control. + + A string value specifying the text associated with the panel. + + + + Gets or sets whether the PanelControl should use the non-default painting mode. + + true if the PanelControl control uses the non-default painting mode; otherwise, false. + + + + Gets or sets whether to stress the control’s disabled state with a semi-transparent gray layer that overlaps the control. + + true, to paint a semi-transparent gray layer above the control in the disabled state; otherwise, false + + + + Contains data for the SvgImageBox.QueryUniqueItemId event. + + + + + Initializes a new instance of the class with specified settings. + + An element’s Id. This value is assigned to the QueryUniqueItemIdEventArgs.Id property. + The Id of the use element. This value is assigned to the QueryUniqueItemIdEventArgs.UseElementId property. + A collection of existing item Ids. This value is assigned to the QueryUniqueItemIdEventArgs.ItemId property. + + + + Gets or sets the Id of the currently processed element. + + The item’s Id. + + + + Gets the current collection of item Ids. + + The current collection of item Ids. + + + + Gets the use element’s Id. + + The use element’s Id. + + + + Serves as the base for , , , and classes. + + + + + Creates a new object. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Applies the specified UI mode to the specified scroll bar. + + A control to which the specified UI mode should be applied. + A enumeration value specifying the UI mode to be applied. + A control whose UI mode has been set. + + + + Applies the default scroll mode to the specified scroll bar. + + A control to which the default UI mode should be applied. + A control whose UI mode has been set. + + + + Gets or sets a value specifying whether the scroll bar is autosized. + + true if auto size is applied; otherwise false. + + + + Prevents the control from being updated until the ScrollBarBase.EndUpdate or ScrollBarBase.CancelUpdate method is called. + + + + + Unlocks the control after a ScrollBarBase.BeginUpdate method call without causing immediate repainting. + + + + + Occurs before the scroll bar is shown on-screen and allows you to manually re-paint it. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Unlocks the control after a ScrollBarBase.BeginUpdate method call and causes its immediate repainting. + + + + + Returns an object which implements the accessibility information. + + A BaseAccessibility object. + + + + Returns the default height, in pixels, of horizontal scroll bars displayed in the current scroll UI mode. + + A value that indicates the default height, in pixels, of a horizontal scroll bar. + + + + Returns the default width, in pixels, of vertical scroll bars displayed in the current scroll UI mode. + + A value that indicates the default width, in pixels, of a vertical scroll bar. + + + + Returns the value of the control’s Enabled property. + + The value of the Enabled property. + + + + Returns the value of the control’s Height property. + + The value of the Height property. + + + + For internal use. + + + + + + + For internal use. + + + + + + + + Returns the UI mode in which the specified scroll bar is displayed. + + A object whose UI mode should be returned. + The scroll bar’s UI mode. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + For internal use. + + + + + + + For internal use. + + + + + + + + Returns the value of the control’s Width property. + + The value of the Width property. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the increment applied to the ScrollBarBase.Value property when the scroll box is moved by a ‘page’. + + An integer value representing the increment applied when the scroll box is moved by a ‘page’. + + + + Gets a value providing access to settings controlling the control’s look and feel. + + A object whose properties specify the control’s look and feel. + + + + Gets or sets the upper limit of values of the scrollable range. + + An integer value representing the value’s upper limit. + + + + Gets or sets the lower limit of the scrollable range. + + An integer value representing a lower limit. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A ScrollNotifyAction enumeration value. + + + + Gets or sets the opacity level of the control. + + A value that specifies the opacity level of the control. The default is 1. + + + + This class supports internal infrastructure and is not intended for use in code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when the scroll thumb has been moved either by a mouse or keyboard action. + + + + + Gets or sets a value specifying whether the scroll bar is automatically sized. + + true if the auto sizing feature is enabled; otherwise false. + + + + Fires after the ScrollBarBase.ScrollBarAutoSize property’s value has been changed. + + + + + Gets the value indicating whether the scroll bar is horizontal or vertical. + + A enumeration member specifying the scroll bar type. + + + + Gets or sets the time interval, in milliseconds, between scroll box steps while a scroll bar button or scroll bar track is clicked and held. + + An integer value that specifies the time interval, in milliseconds, between scroll box steps while the scroll bar button or scroll bar track is clicked and held. + + + + Sets the visibility of the current control. This method is not in effect if the scroll bar is displayed in the touch UI mode. + + true to display the control; false to hide the control. + + + + Gets or sets the value by which the ScrollBarBase.Value property changes when the user presses one of the arrow keys or clicks one of the scroll-bar buttons. + + An integer value by which the ScrollBarBase.Value property changes. + + + + Gets whether the scroll bar is in normal state, or the increase/decrease/thumb button/area is pressed/hot-tracked. + + A DevExpress.XtraEditors.ViewInfo.ScrollBarState enumeration value that specifies the scroll bar state. + + + + Returns whether this scroll bar can display Scrollbar Annotations. + + true if this scroll bar can display annotations; otherwise, false. + + + + Gets or sets a value indicating whether a user can focus the scroll bar control using the TAB key. + + true if a user can focus the scroll bar using the TAB key; otherwise, false. + + + + Gets or sets whether scroll bars are optimized for desktop or touch applications. This is a static (Shared in VB.NET) property. + + A enumeration value that specifies how scroll bars are displayed. + + + + Gets or sets a value specifying the scroll box’s current position. + + An integer value representing the scroll box’s current position. + + + + Fires immediately after the ScrollBarBase.Value property has been changed. + + + + + Contains values specifying the type of ScrollBar control. + + + + + Corresponds to the horizontal orientation of the scroll bar. + + + + + + Corresponds to the vertical orientation of the scroll bar. + + + + + + Lists values that specify the scrollbar orientation. + + + + + The horizontal scroll bar. + + + + + The vertical scroll bar. + + + + + Enumerates modes that specify the appearance and behavior of scroll bars. + + + + + The mode is not specified explicitly. Enables mode. + + + + + Scroll bars optimized for desktop applications. Auto-hide and auto-expand functionality are not supported. + + + + + Scroll bars optimized for Fluent Design Forms. They are expanded when a user flicks scrollable content (or the mouse cursor moves over the control) and collapsed to a thin stripe if the control is not scrolled (or the mouse cursor does not move) for some time. The arrow buttons are never displayed. + + + + + Scroll bars optimized for touch applications. They are shown when a user flicks the scrollable content (or the mouse pointer moves over the control), and hidden when the control is not scrolled (or the mouse pointer does not move) for some time. The arrow buttons are never displayed. This style is outdated, use the Fluent style instead. + + + + + Allows you to delimit controls within the layout. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the control client area size is automatically calculated based on the separating line thickness and paddings. + + true if the control client area size is automatically calculated based on the separating line thickness and paddings; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + Invalidates the entire surface of the control and causes the control to be redrawn. + + + + + Gets or sets the alignment of the separating line within the control client area. + + A DevExpress.XtraEditors.Alignment enumeration value that specifies the alignment of the separating line within the control client area. + + + + Gets or sets the color of the separating line. + + A structure that specifies the color of the separating line. + + + + Gets or sets the orientation of the separating line. + + A enumeration value that specifies the orientation of the separating line. + + + + Gets or sets the dash style of the separating line. This property is in effect when the control is painted using any paint theme, except skins. + + A enumeration value that specifies the dash style of the separating line. + + + + Gets or sets the width, in pixels, of the separating line. This property is in effect when the control is painted using any paint theme, except skins. + + An integer value that specifies the width, in pixels, of the separating line. + + + + Provides access to settings controlling the look and feel of the control. + + A object whose properties specify the look and feel of the control. + + + + Gets or sets the amount of space around the separating line. + + A structure that specifies the amount of space around the separating line. + + + + Sets the SeparatorControl.LineColor property to Color.Empty. + + + + + Sets the SeparatorControl.LineThickness property to the default value. + + + + + Sets the SeparatorControl.Padding property to the default value. + + + + + Returns whether the SeparatorControl.LineColor property should be serialized. + + true if the SeparatorControl.LineColor property should be serialized; otherwise, false. + + + + Returns whether the SeparatorControl.LineThickness property should be serialized. + + true if the SeparatorControl.LineThickness property should be serialized; otherwise, false. + + + + Returns whether the SeparatorControl.Padding property should be serialized. + + true if the SeparatorControl.Padding property should be serialized; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + A panel with one-pixel borders that supports panel snapping and the overlay resize feature. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether or not end-users can resize this by dragging its border. + + true if end-users can resize this by dragging its border; otherwise, false. + + + + Gets or sets whether or not borders of this are allowed to snap to borders of other panels at runtime. + + true if borders of this panel can snap to other panels’ borders; otherwise, false. + + + + Provides access to this panel’s appearance settings. + + A object that stores appearance settings applied to this . + + + + Gets or sets this panel’s background color. + + A Color that is this panel’s background color. + + + + Gets or sets the border thickness. + + An Int32 value that specifies the border thickness. + + + + Returns the rectangle structure that specifies the position and size of this . + + A structure that stores this ‘s position and size. + + + + Gets or sets the parent container side to which this is docked. + + A enumeration value that specifies the parent container side to which this is docked. + + + + Gets or sets the fore color of this and its child controls. + + A Color that is the fore color of this and its child controls. + + + + Gets or sets the actual border thickness scaled according to the current DPI settings. + + An Int32 value that specifies the border thickness. + + + + Provides access to Look and Feel settings of this . + + A object that stores look&feel settings of this . + + + + Occurs when a mouse pointer enters the overlay resize zone of this panel. + + + + + Gets or sets the width of a ‘s overlay resize zone. + + An Int32 value that specifies the width of a ‘s overlay resize zone. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the panel is redrawn. + + + + + Resets this panel’s SidePanel.BackColor property to its default value. + + + + + Gets or sets the distance from the border of this to the border of another panel, starting from which the panel snapping feature activates. + + An Int32 value that is the distance between panel borders, starting from which the panel snapping feature activates. + + + + The base class for controls that support the DevExpress look and feel mechanism. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets the style used to draw the control’s border. + + A enumeration member specifying the border style of the control. + + + + Gets an object containing the control’s look and feel settings. + + A object containing the control’s look and feel settings. + + + + A control that consists of two panels separated by a splitter, which can be dragged by an end user to resize the panels. + + + + + Initializes a new instance of the class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A Boolean value. + + + + Gets or sets if end-users can scroll the by dragging its content. + + true if end-users can scroll the by dragging its content; otherwise, false. + + + + This property is not relevant for this class. + + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Starts the split container’s initialization. Initialization occurs at runtime. + + + + + Occurs after an end-user clicks the ‘s splitter. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + Gets or sets a value indicating whether the panel referred to by the SplitContainerControl.CollapsePanel property is collapsed. + + true if the panel is collapsed; otherwise, false. + + + + Gets or sets the panel that is automatically collapsed when clicking on a splitter. + + A SplitCollapsePanel enumeration value that specifies the panel automatically collapsed when clicking on a splitter. + + + + Gets the collection of controls contained within the split container control. + + A object which represents the collection of controls contained within the split container control. + + + + Gets or sets the cursor that is displayed when the mouse pointer is over the current . + + A System.Windows.Forms.Cursor object that represents the cursor to display when the mouse pointer is over the control. + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + Not supported for this class. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + Ends the split container’s initialization. + + + + + Gets or sets a panel that remains static when the split container size changes. + + A enumeration value which specifies the fixed panel. + + + + This property is not relevant for this class. + + + + + Gets or sets whether the panels are arranged horizontally or vertically. + + true if the panels are arranged horizontally; false if the panels are vertically. + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + Gets whether the panel specified by the SplitContainerControl.CollapsePanel property is collapsed. + + true if this panel is collapsed; otherwise, false. + + + + Gets or sets whether the ‘s splitter is locked at the current position. + + true if the ‘s splitter is locked at the current position; otherwise, false. + + + + Gets the left (or top) panel. + + A DevExpress.XtraEditors.SplitGroupPanel object which represents the left (or top) panel. + + + + Gets the right (or bottom) panel. + + A DevExpress.XtraEditors.SplitGroupPanel object which represents the right (or bottom) panel. + + + + Gets or sets the visibility of the panels. + + A enumeration value which specifies the visibility of panels. + + + + Loads the current ‘s layout from the system registry. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A String value which specifies the system registry path. If the specified path doesn’t exist, this method does nothing. + + + + Loads the current ‘s layout from the specific stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + The Stream from which the the current ‘s layout should be restored. + + + + Loads the current ‘s layout from the specific XML file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A String value that is the path to an XML file where the current ‘s layout should be restored from. + + + + Saves the current ‘s layout to the system registry. + + A String value that is the system registry path to which the current ‘s layout should be saved. + + + + Saves the current ‘s layout to a stream. + + A stream where the layout should be stored. + + + + Saves the current ‘s layout to the specific XML file. + + A String value that is the path to an XML file where the current ‘s layout should be saved. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Specifies the border style of the panels. + + A enumeration value specifying the border style of the panels. + + + + Collapses or restores the panel referred to by the SplitContainerControl.CollapsePanel property. + + true to collapse the panel; false to restore the panel. + + + + Gets or sets whether the split container’s caption is displayed. + + true to display the split container’s caption; otherwise, false. + + + + Gets or sets whether to display the split glyph. + + A value that specifies the spit glyph’s visibility. The DefaultBoolean.Default value, if the paint theme (skin) controls the split glyph visibility. + + + + Allows you to respond to collapsing/restoring a panel. + + + + + Allows you to prevent a panel from being collapsed/restored. + + + + + Gets the splitter’s size and location. + + A structure which represents the size and location of the splitter. + + + + Occurs after the splitter’s position has been changed. + + + + + Occurs when the splitter’s position is being changed. + + + + + Gets or sets the splitter’s location. + + An integer value specifying the splitter’s current location in pixels, from the side of the fixed panel. + + + + Occurs after the splitter’s position has been changed. + + + + + Swaps the contents of the first and second panels. + + + + + This property is not relevant for this class. + + + + + This property is not relevant for this class. + + + + + Lists values that specify which panel within the split container is fixed. + + + + + The panels’ widths (or heights) are proportionally changed when a split container is being resized. + + + + + The width (height if the panels are displayed one above another) of the SplitContainerControl.Panel1 isn’t changed when the split container is resized. + + + + + The width (height if the panels are displayed one above another) of the SplitContainerControl.Panel2 isn’t changed when the split container is resized. + + + + + Lists values that specify the visibility of the panels within a split container. + + + + + Both Panel1 and Panel2 are visible. + + + + + Panel2 is hidden. + + + + + Panel1 is hidden. + + + + + Allows end users to resize controls that are docked to the splitter’s edges. + + + + + Initializes a new instance of the class. + + + + + Gets the appearance settings used to paint the splitter. + + An object which contains the splitter’s appearance settings. + + + + Gets or sets the splitter’s background color. + + A structure which specifies the splitter’s background color. + + + + Provides access to the settings which control the splitter’s look and feel. + + A object whose properties specify the splitter’s look and feel. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether to display the split glyph. + + A value that specifies the spit glyph’s visibility. The DefaultBoolean.Default value, if the paint theme (skin) controls the split glyph visibility. + + + + Allows you to customize and display an SVG image and enables end-user interaction with individual image elements. + + + + + Initializes a new instance of the class. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Fires when a context button is clicked. + + + + + Provides access to the settings that control the display of context buttons. + + The object that contain settings to customize the display of context buttons. + + + + Provides access to the collection of context buttons displayed in the control. + + The collection of context buttons displayed in the control. + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Returns the current image as an object. + + An optional object that contains export options. + The result of the operation. + + + + Saves the current image to the specified stream in SVG format. + + A object to which data is exported. + An optional object that contains export options. + + + + Saves the current image to the specified file in SVG format. + + The path to the file to which the image is exported. + An optional object that contains export options. + + + + Returns an item that matches the specified condition. + + The search condition. + The found item. Null, if no item matches the specified condition. + + + + Returns the item with the specified Id. + + The Id property value of the target item. + The found item. Null, if no item with the specified ID is found. + + + + Returns the item with the specified Tag. + + The Tag property value of the target item. + The found item. Null, if no item with the specified Tag is found. + + + + Returns a list of items that match the specified condition. + + The search condition. + The list that contains found items. + + + + Returns hidden and visible image items displayed at the specified point. + + The target point, in client coordinates. + A array of items located at the specified point. An empty array, if no item is positioned at this point. + + + + Returns hidden and visible items that are entirely or partially positioned within the specified bounds. + + The bounds, in client coordinates. + An array of items located within the specified coordinates. An empty array, if no item is positioned at this point. + + + + Returns visible image items displayed at the specified point. + + The target point, in client coordinates. + A array of visible items located at the specified point. An empty array, if no item is positioned at this point. + + + + Returns visible items that are entirely or partially positioned within the specified bounds. + + The bounds, in client coordinates. + An array of items located within the specified coordinates. An empty array, if no item is positioned at this point. + + + + Gets the hovered image item. + + The hovered item. + + + + Gets or sets how the image is aligned within the control’s bounds. + + A value that specifies how the image is aligned within the control’s bounds. + + + + Provides access to the default item appearance settings. + + The default item appearance settings. + + + + Occurs when a user clicks an in the . + + + + + Fires when the mouse cursor enters the item’s graphical path or bounding rectangle. + + + + + Gets or sets the item hit-test type. + + The item detection type. + + + + Fires when the mouse cursor leaves the item’s graphical path or bounding rectangle. + + + + + Occurs when a user presses the left mouse button on an . + + + + + Gets or sets the control’s look-and-feel. + + The control’s look-and-feel settings. + + + + Contains settings to customize export output from the SvgImageBox.ExportSvgImage methods. + + An object that contains export options. + + + + Contains item selection options. + + The item selection options. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. + + + + + Fires when a user right-clicks with the mouse. Allows you to display a context menu for image items. + + + + + Gets the currently pressed item. + + The currently pressed item. null if no item is currently pressed. + + + + Allows you to specify a custom item as “hovered” when you move the mouse cursor over items, regardless of their visibility. For instance, you can specify a group as “hovered” when you hover over the group’s item. + + + + + Allows you to assign unique Ids to cloned elements that the control creates when the SVG file contains use elements. + + + + + Provides access to a collection of root (bottommost) SVG items. + + A root item collection. + + + + Selects the specified item. + + The item to select. + + + + Provides access to the currently selected items. + + A collection of selected items. + + + + A notification event, which is raised after the item selection has been changed. + + + + + Fires when the item selection is about to be changed. Allows you to cancel the current operation. + + + + + Gets or sets whether objects owned by this control can show tooltips when users hover over these items. + + Specifies whether items can show super tooltips and regular hints. + + + + Gets or sets whether and how the image is stretched. + + A value that specifies whether the image is stretched, and how. + + + + Gets or sets a super tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips. + + A super tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips. + + + + Gets or sets the SVG image. + + The displayed SVG image. + + + + Gets or sets the colorization mode for the object’s SVG image. + + Colorization mode. + + + + Gets or sets a regular tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips. + + A regular tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips. + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or the hovered item. + + A value that specifies whether the tooltip is anchored relative to the mouse pointer or the hovered item. In Default mode, the behavior depends on the ToolTipController.ToolTipAnchor property. + + + + Gets or sets a that allows items to show tooltips. + + Manages tooltips for SvgImageBox items. + + + + Gets or sets a regular tooltip’s icon type. + + A regular tooltip’s icon type. + + + + Gets or sets a regular tooltip’s title. + + A regular tooltip’s title. + + + + Deselects the specified item. + + The item to deselect. + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for the current . + + A DefaultBoolean enum value that specifies whether this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + Contains settings that customize export output from the SvgImageBox.ExportSvgImage methods. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Copies all settings from the options object passed as the parameter and assigns them to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the ExportSvgImage method saves item appearance settings. The property allows you to choose which appearance settings to save. + + A combination of flags that specify which item appearance settings to save. + + + + Contains item selection options for the control. + + + + + Initializes a new instance of the class with specified settings. + + + + + Copies settings from the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Gets or sets item selection mode. + + Item selection mode. The Default value is equivalent to Multiple. + + + + Gets or sets whether a user needs to press the CTRL key to select image items by clicking them with the mouse cursor. This property is in effect in Multiple selection mode. + + True if a user needs to press the CTRL key to select image items by clicking them with the mouse cursor; otherwise, False or Default. + + + + An item within an SVG image. + + + + + Initializes a new instance of the class. For internal use. + + + + + Initializes a new instance of the class. For internal use. + + + + + Returns whether the item is actually enabled. + + true if the item is actually enabled; otherwise, false + + + + Returns whether the item is actually visible. + + true if the item is actually visible; otherwise, false + + + + Allows you to customize the item’s appearance. + + The appearance settings applied to the current item. + + + + Gets the ‘s bounds. + + A structure that stores ‘s bounds. + + + + Creates a copy of the current item. + + A copy of the current item. + + + + Returns a linear list of the item’s descendants. + + The linear list of the item’s descendants. + + + + Gets or sets whether the item is enabled. + + true if the item is enabled; otherwise, false. + + + + Returns the item’s ancestor that matches the specified condition. + + The search condition. + The found item. Null, if no ancestor matches the specified condition. + + + + Returns the item’s ancestor with the specified Id. + + The Id property value of the target ancestor. + The found item. Null, if no item with the specified ID is found. + + + + Returns the item’s ancestor with the specified Tag. + + The Tag property value of the target ancestor. + The found item. Null, if no item with the specified Tag is found. + + + + Returns a list of the item’s ancestors that match the specified condition. + + The search condition. + The list that contains found items. + + + + Returns the item’s descendant that matches the specified condition. + + The search condition. + The found item. Null, if no descendant matches the specified condition. + + + + Returns the item’s descendant with the specified Id. + + The Id property value of the target descendant. + The found item. Null, if no item with the specified ID is found. + + + + Returns the item’s descendant with the specified Tag. + + The Tag property value of the target descendant. + The found item. Null, if no item with the specified Tag is found. + + + + Returns a list of the item’s descendants that match the specified condition. + + The search condition. + The list that contains found items. + + + + Gets whether the item has a background. + + true if the item has a background; otherwise, false. + + + + Gets whether the item has a border. + + true if the item has a border; otherwise, false. + + + + Gets whether the item is hovered. + + true if the item is hovered; otherwise, false. + + + + Gets or sets the item’s unique identifier. The SVG image format allows IDs to be assigned to items via the id attribute. + + The item’s ID. + + + + Gets whether the current item is a group. + + true if the current item is a group; otherwise, false. + + + + Gets whether the current item is the root item. + + true if the current item is the root item; otherwise, false. + + + + Gets whether the current item only has text content. + + true if the item’s content is text; otherwise, false. + + + + Gets the current group’s children. + + A child item collection. + + + + Gets a that draws the current . + + A Pen that draws the current SvgImageItem. + + + + Returns the item’s immediate parent. + + The item’s parent. + + + + Gets a that outlines the current . + + A GraphicsPath that outlines the current SvgImageItem. + + + + Fires when the item’s properties are changed. + + + + + Gets the item’s root ancestor. + + The item’s root parent. + + + + Gets or sets whether the item is selected. + + true if the item is selected; otherwise, false. + + + + Gets or sets a super tooltip for this item. + + A super tooltip shown when a user hovers overs this item. + + + + Use this property to associate custom data with the item. + + An object associated with the item. + + + + Gets or sets the item’s text. This property is supported for items that only have text content in the source SVG file. + + The item’s text. + + + + Gets or sets the item’s regular tooltip. + + A hint shown when a user hovers over this item. + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or the hovered item. + + A value that specifies whether the tooltip is anchored relative to the mouse pointer or the hovered item. In Default mode, the behavior depends on the ToolTipController.ToolTipAnchor property. + + + + Gets or sets a regular tooltip’s icon type. + + A regular tooltip’s icon type. + + + + Gets or sets a regular tooltip’s title. + + A regular tooltip’s title. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A Matrix object. + + + + Gets or sets the item’s visibility. An item can still be hidden if any parent group of the item is hidden. + + true if item item is visible; otherwise, false + + + + Contains appearance settings to paint image items. + + + + + Initializes a new instance of the class with specified settings. + + The owner of the created SvgImageItemAppearance object. + + + + Initializes a new instance of the class with specified settings. + + The owner of the created SvgImageItemAppearance object. + + + + Copies settings from the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Gets or sets a custom border color applied to an image item. + + A custom border color. + + + + Gets or sets the custom border’s thickness, in pixels. When the image is scaled based on the SvgImageBox.SizeMode setting, the custom borders are scaled as well. + + The border’s thickness, in pixels. If the value is zero or negative, no custom border is painted. + + + + Gets or sets a custom background color applied to an image item. + + A custom background color. + + + + Contains appearance settings for SVG image items. + + + + + Initializes a new instance of the class with specified settings. + + The control that will own the created collection. + + + + Initializes a new instance of the class with specified settings. + + The item that will own the created collection. + + + + Copies settings from the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Gets the appearance settings applied in the disabled state. + + The appearance settings applied in the disabled state. + + + + Gets the appearance settings applied in the hovered state. + + The appearance settings applied in the hovered state. + + + + Gets the appearance settings applied in the normal state. + + The appearance settings applied in the normal state. + + + + Gets the appearance settings applied in the pressed state. + + The appearance settings applied in the pressed state. + + + + Fires when the object’s properties are changed. + + + + + Resets all settings to their default values. + + + + + Gets the appearance settings applied in the selected state. + + The appearance settings applied in the selected state. + + + + Gets the object’s textual representation. + + The object’s textual representation. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + + + + Disposes of the current collection. + + + + + Provides indexed access to items in the current collection. + + A zero-based item position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + An item at the specified position. + + + + Supplies data for image item-related events. + + + + + Initializes a new instance of the class. + + The object to initialize the SvgImageItemEventArgs.Item property. + + + + Gets the currently processed item. + + The currently processed item. + + + + Contains data for the event. + + + + + Gets the pressed mouse button. + + The pressed mouse button. + + + + Gets or sets whether to manually process item clicks. + + true to manually process item clicks; otherwise, false. + + + + Gets the mouse location relative to the control’s top left corner. + + The mouse location. + + + + Gets the mouse x-coordinate relative to the control’s top left corner. + + The mouse x-coordinate. + + + + Gets the mouse y-coordinate relative to the control’s top left corner. + + The mouse y-coordinate. + + + + Supplies data for the PopupMenuShowing event. + + + + + Initializes a new instance of the class. + + The object to initialize the Menu property. + The object to initialize the Item property. + The object to initialize the Point property. + The object to initialize the Allow property. + + + + Gets or sets whether to allow the menu to be displayed. + + true, to allow the menu to be displayed; otherwise, false + + + + Gets the clicked item. + + The clicked item. + + + + Gets or sets the popup menu that is about to be displayed + + Gets or sets the popup menu that is about to be displayed + + + + Gets the position where the menu is to be invoked. + + The position where the menu is to be invoked. + + + + Stores selected image items. + + + + + Initializes a new instance of the class with specified settings. + + The control that will own the created collection. + + + + Adds the specified items to the collection, and thus selects these items. + + The items to be selected. + + + + Provides indexed access to items in the current collection. + + A zero-based item position within the collection. If it’s negative or exceeds the last available index, an exception is raised. + An item at the specified position. + + + + Supplies data for the SvgImageBox.SelectionChanging event. + + + + + Initializes a new instance of the class. + + The object to initialize the Item property. + The object to initialize the Action property. + + + + Gets or sets how the selected item collection has been changed. + + A value that specifies how the selected item collection has been changed. + + + + Gets or sets the currently processed item. + + The currently processed item. + + + + Specifies size mode for images within the SvgImageBox control. + + + + + An image is not stretched. + + + + + An image is displayed as is if its actual size is smaller than the size of the container. If the image size is larger than the container’s size, the image is shrunk proportionally to fit the container’s bounds. + + + + + An image is stretched to fit in the control’s area. + + + + + An image is stretched proportionally. The image fits within the area of the container in at least one direction. + + + + + Contains classes that support the internal infrastructure of DevExpress editors and controls. + + + + + Lists the available scroll bar visibility modes. + + + + + The scroll bar is hidden. + + + + + The scroll bar is visible. + + + + + The vertical scrollbar. + + + + + Creates a new object. + + + + + This member overrides Control.RightToLeft. + + One of the System.Windows.Forms.RightToLeft values. + + + + Sets the visibility of the current control. + + true to display the control; false to hide the control. + + + + Returns whether this scroll bar can display Scrollbar Annotations. + + true if this scroll bar can display annotations; otherwise, false. + + + + Serves as the base for the class. + + + + + Gets the value indicating whether the scroll bar is horizontal or vertical. + + A enumeration member specifying scroll bar orientation. + + + + Exposes appearance and behavior settings common to all DevExpress controls. + + + + + Gets or sets whether dragging-and-dropping columns/fields is indicated using arrow indicators. This is a static property. + + true if dragging-and-dropping columns is indicated using arrow indicators; otherwise, false. + + + + Gets or sets whether or not Data Grid and TreeList automatic filtering rows should display buttons that allow end-users to change the filtering condition. + + A DefaultBoolean value that specifies whether or not DataGrid and TreeList automatic filtering rows should display buttons that allow end-users to change the filtering condition. + + + + Gets or sets whether or not automatically generated UI elements (e.g., Grid context menu items) should display vector icons. + + DefaultBoolean.True if UI elements should display vector icons; DefaultBoolean.False to display raster icons instead. + + + + Gets or sets whether or not DevExpress Skins can be scaled on high-DPI devices. + + true if DevExpress Skins can be scaled on high-DPI devices; otherwise, false. + + + + Gets whether the form title bar skinning feature is enabled. This is a static property. + + true if the form title bar skinning feature is enabled; otherwise, false. + + + + Gets or sets whether animation on hovering objects is enabled. This is a static property. + + A value that specifies whether animation on hovering objects is enabled. + + + + Gets or sets whether the window bounce (panning feedback) is enabled when an end-user tries to pan (scroll with the finger) beyond a control’s pannable area. This is a static property. + + Default or True if the window panning feedback is enabled; False if this visual effect is disabled. + + + + Gets or sets whether smooth pixel-based scrolling is enabled for controls. This is a static property. + + A DefaultBoolean value that specifies whether smooth pixel-based scrolling is enabled for controls. + + + + Gets or sets whether or not all s used within this app should use the Windows 7 Aero effect. + + A enumerator value that specifies whether or not all s used within this app should use the Windows 7 Aero effect. + + + + Specifies whether forms, dialogs, panels and tooltips have rounded corners. When this option is enabled, the form’s borders, including shadows, are drawn by the operating system. This option is only in effect in Windows 11. + + DefaultBoolean.Default or DefaultBoolean.False to display square corners; DefaultBoolean.True to display rounded corners. + + + + Gets or sets whether or not you can use this application to preview custom skins in WinForms Skin Editor. + + true if this application can be used to preview custom skins; otherwise, false. + + + + Gets or sets whether the window ghosting feature is enabled for skinned XtraForm objects. This is a static property. + + A Boolean value that specifies whether the window ghosting feature is enabled. The default value is false. + + + + Gets or sets whether DevExpress controls animate end-user operations (expand/collapse, tab switch, sorting, etc.). This is a static (shared in VB) property. + + An DevExpress.XtraEditors.AnimationMode enumeration value that specifies whether DevExpress controls use animation effects. The default is DevExpress.XtraEditors.AnimationMode.Default. + + + + This method is called by DevExpress demos to apply specific settings. This is a static method. + + + + + Gets or sets whether UI elements should automatically adjust their foreground colors when these elements use DX Skin Colors for backgrounds. This behavior ensures the foreground color has enough contrast against the background to improve readability. + + A enumeration value that specifies whether background/border DX Skin Colors should adjust foreground colors as well. + + + + Gets or sets whether colors assigned to AppearanceObject.BackColor or AppearanceObject.BorderColor properties can blend with skin element bitmaps. + + A DevExpress.XtraEditors.BackgroundSkinningMode object enumerator value that specifies what appearance colors can blend with skin element bitmaps. + + + + Allows you to restore default filtering conditions for all Data Grid auto-filter rows to their 16.2 versions. + + A DevExpress.XtraEditors.ColumnAutoFilterMode enumerator value. + + + + Gets or sets the default display mode of column filter dropdowns in all s, s and s in the current application. + + A value that specifies the default display mode of column filter dropdowns in all GridControls and TreeLists in the current application. + + + + Reduces control paddings and margins to display more information on-screen in data-intensive applications. You can enable this mode at design time in the Project Settings Page. + + Specifies whether the Compact UI mode is enabled. The Default value is equal to False. + + + + Gets or sets whether or not customization forms can stick to each other, parent forms or screen edges. + + A SnapMode enumerator value that specifies whether or not dock panels can stick to each other, parent forms or screen edges. + + + + Indicates whether HTML text formatting is enabled for controls by default. This is a static property. + + true if HTML text formatting is enabled for controls by default; otherwise, false. + + + + Gets or sets the default font for DevExpress controls (except menus and toolbars). This is a static property. + + A object which is the default font for controls. The default value is the Tahoma font. + + + + Gets the default object which is used for painting controls. This is a static property. + + A object. + + + + Gets and sets the default font used to display text on menus, toolbars and popup menus (except Ribbon elements). This is a static property. + + A object which is the default font for menu items. If not set, the property value is specified by the System.Windows.Forms.SystemInformation.MenuFont property. + + + + Gets or sets the default text font for printing. This is a static property. + + A System.Drawing.Font object that defines the default text font for printing. + + + + Gets or sets the default style for all s in the application. + + The ‘s default style. + + + + Modifies default values of various properties according to the selected DevExpress installation version. + + + + + Gets or sets whether the accessibility features (interaction with accessibility tools such as Microsoft Narrator) of DevExpress controls are disabled. This is a static property, and thus it affects all controls in your application. + + DefaultBoolean.True if accessibility features are disabled; otherwise, DefaultBoolean.False. + + + + Disables the title bar skinning feature for DevExpress forms and message boxes. + + + + + Disables the title bar skinning feature for MDI child DevExpress forms. + + + + + Disables window shadows for , , and . + + + + + Gets or sets the style for all and panels in this application. + + A DevExpress.XtraBars.Docking2010.Views.DockingViewStyle enumeration value that specifies the style for all and panels in this application. + + + + Gets or sets whether the scroll bar thumb restores its previous position or keeps the terminal position when it is dragged beyond a control. This is a static property. + + A DragScrollThumbBeyondControlMode enumeration value that specifies whether the scroll bar thumb restores its previous position or keeps the terminal position when dragged beyond a control. + + + + Gets or sets the threshold, in pixels, beyond which the previous vertical scroll bar thumb position is restored. This property is in effect in the RestoreThumbPosition mode. This is a static property. + + An integer value that specifies the threshold, in pixels, beyond which the previous vertical scroll bar thumb position is restored. The default value is 50 pixels. + + + + Gets or sets whether to enable the Coded UI Test Extension. + + Security note: We do not recommend enabling this functionality by default. Review all security-related matters and mitigate associated risks before enabling the DevExpress Coded UI Test extension to enhance overall security and maintain application integrity. Learn more + + A value that specifies whether to enable the Coded UI Test Extension (disabled by default). + + + + Enables the title bar skinning feature for DevExpress forms and message boxes. + + + + + Enables the title bar skinning feature for DevExpress forms and message boxes, if the application is running under Microsoft Windows XP. + + + + + Enables the title bar skinning feature for MDI child DevExpress forms. + + + + + Re-enables form, message and dialog shadows that have been turned off with the WindowsFormsSettings.DisableWindowShadows() method call. Can also be used to display shadows through remote connections when the WindowsFormsSettings.OptimizeRemoteConnectionPerformance property is enabled. + + + + + Gets or sets the default display style of filter conditions in a control’s Filter Panel, MRU Filter List, and built-in Filter Editor. + + The default display style of filter conditions in a control’s Filter Panel and built-in Filter Editor + + + + Gets or sets whether records that do not match a query in a find panel are hidden. + + A enumeration value that specifies whether records that do not match the query are hidden. + + + + Specifies the default comparison operator (Contains, Equals, StartWith, etc.) a control uses to search for words entered in a Find Panel. This setting is applied to all controls that have their OptionsFind.Condition properties set to Default. + + The default comparison operator. + + + + Specifies the default behavior of a control’s Find Panel when it combines entered words to create a search query. This setting is applied to all controls that have their OptionsFind.ParserKind properties set to Default. + + The default ColumnViewOptionsFind.ParserKind property value for all Data Grids in the project. + + + + Gets or sets the style of dashed lines to paint focus rectangles. This is a static property. + + A DXDashStyle enumeration value that specifies the style of dashed lines to paint focus rectangles. + + + + Gets or sets the behavior specifying fonts used by DevExpress and standard .Net controls. This is a static property. Setting this property modifies the WindowsFormsSettings.DefaultFont property. + + A DevExpress.XtraEditors.WindowsFormsFontBehavior enumeration value that specifies the behavior specifying fonts used by DevExpress and standard .Net controls. + + + + Gets or sets the default icon font style. + + The icon form style. + + + + Enables the mixed use of the DevExpress text rendering library and System.Windows.Forms.TextRenderer class functionality. + + + + + Turns the DirectX Hardware Acceleration on. + + + + + Enables the use of the System.Drawing.Graphics class for text rendering. + + + + + Allows you to trace all outdated APIs that are not recommended for use with DirectX-rendered and Per-Monitor DPI-aware applications. Starting with version 18.2, also traces Appearance.BackColor properties modified for skinned UI elements. + + A enumerator value that specifies how the application responds to this inadvisable API. + An optional object that allows you to implement a custom trace behavior. + + + + Enables the use of the System.Windows.Forms.TextRenderer class for rendering text. + + + + + Gets or sets whether all and forms in the application should display thick borders. + + true, to display thick borders; otherwise, false. + + + + Returns a custom accent color. + + The accent color. + + + + Returns the second accent color. + + The second accent color. Color.Empty if the second accent color is not specified. + + + + Returns the actual value of the WindowsFormsSettings.AllowDefaultSvgImages property. + + true if generated UI elements should receive vector icons; otherwise, false. + + + + Returns whether animation on hovering objects is enabled. This is a static method. + + An object that provides information on the current skin. + true if animation on hovering objects is enabled; otherwise, false. + + + + Returns whether this application can serve as an External Preview Application in WinForms Skin Editor. See the WindowsFormsSettings.AllowSkinEditorAttach property for the details. + + true if this application can serve as an External Preview Application in WinForms Skin Editor; otherwise, false. + + + + Returns the current WindowsFormsSettings.AutoCorrectForeColor property setting. + + true if the WindowsFormsSettings.AutoCorrectForeColor property equals DefaultBoolean.Default or DefaultBoolean.True; otherwise, false. + + + + Returns a Boolean value that indicates whether the specified control is actually aligned to support locales using right-to-left fonts. This is a static method. + + A Control object. + true if the specified control is actually aligned to support locales using right-to-left fonts; otherwise, false. + + + + Returns a Boolean value that specifies whether DevExpress controls are aligned to support locales using right-to-left fonts. The method parameter allows the default behavior to be specified. This is a static method. + + A RightToLeft enumeration value that specifies the default behavior that is used if the WindowsFormsSettings.RightToLeft property equals Default. + true if DevExpress controls are aligned to support locales using right-to-left fonts; otherwise, false. + + + + Returns a Boolean value that indicates whether right-to-left mirror placement is turned on. The method parameter allows the default behavior to be specified. This is a static method. + + A default Boolean value that is returned if the WindowsFormsSettings.RightToLeftLayout property equals Default. + A Boolean value that indicates whether right-to-left mirror placement is turned on. + + + + Returns a Boolean value that indicates whether right-to-left mirror placement is turned on for the specified control or form. This is a static method. + + A Control object. + A Boolean value that indicates whether right-to-left mirror placement is turned on for the specified control or form. + + + + Returns a RightToLeft enumeration value that indicates whether the specified control is actually aligned to support locales using right-to-left fonts. This is a static method. + + A Control object. + A System.Windows.Forms.RightToLeft enumeration value that indicates whether the specified control is actually aligned to support locales using right-to-left fonts. + + + + Returns a RightToLeft enumeration value that specifies whether DevExpress controls are aligned to support locales using right-to-left fonts. The method parameter allows the default behavior to be specified. This is a static method. + + A default System.Windows.Forms.RightToLeft enumeration value that is returned if the WindowsFormsSettings.RightToLeft property equals Default. + A System.Windows.Forms.RightToLeft enumeration value that specifies whether DevExpress controls are aligned to support locales using right-to-left fonts. + + + + Gets or sets edit value update mode for s which display inplace editors in bars (see Bar Manager) and Ribbon controls. + This property is supported for a limited set of inplace editors. See the Remarks section for more information. + + An DevExpress.XtraEditors.InplaceEditorUpdateMode enumerator value that specifies the edit value update mode for inplace editors. + + + + Gets whether smooth pixel-based scrolling is enabled for controls. + This is a static property. + + true if smooth pixel-based scrolling is enabled for controls; otherwise, false. + + + + Loads application settings and updates the corresponding CLR properties accordingly. + + + + + Gets or sets whether all child MDI and forms in the application should display increased borders. + + true, to display thick borders; otherwise, false. + + + + Gets or sets whether the application should disable various visual effects to enhance the performance when accessed over slow remote connections. + + Specifies whether the remote connection optimization is on. The Default value is equal to false. + + + + Gets or sets the animation effects that follow expanding and collapsing popup menus. + + A DevExpress.XtraEditors.PopupAnimation enumerator value that specifies animation effects that follow expanding and collapsing popup menus. + + + + Gets or sets whether the DevExpess controls’ built-in context menus are displayed in the classic rectangular or radial style. This is a static property. + + A PopupMenuStyle enumeration value that specifies the style in which built-in context menus are displayed. + + + + Specifies the shadow style applied to all popup menus in this application. + + A DevExpress.XtraEditors.PopupShadowStyle enumerator value that specifies the shadow style applied to all popup menus in this application. + + + + Gets or sets the culture settings used by date-time (calendar, scheduler, etc.) controls for month names, day abbreviations, and the first day of week. + + A DevExpress.XtraEditors.DateTimeCulture enumeration value, such as CurrentCulture and CurrentUICulture, that specifies the culture used by date-time controls. + + + + Registers the specified skin stored as a BLOB for runtime use. This method replaces the previously used SkinManager.RegisterSkin(SkinCreator) method that did not affect splash screens and required that you call the additional SplashScreenManager.RegisterUserSkins(Assembly) method. + + An object that contains information on the target BLOB skin. + + + + Registers all skins from the target assembly, allowing you and your users to apply them. This method replaces the previously used SkinManager.Default.RegisterAssembly method that did not affect splash screens and required that you call the additional SplashScreenManager.RegisterUserSkins(Assembly) method. + + Custom skin storage. + + + + Gets or sets whether visual elements of DevExpress controls are aligned to support locales using right-to-left fonts. This is a static property. + + A enumeration value that specifies whether visual elements of DevExpress controls are aligned to support locales using right-to-left fonts. + + + + Gets or sets whether right-to-left mirror placement is turned on. + + A value that specifies whether right-to-left mirror placement is turned on. + + + + Gets or sets whether scroll bars are optimized for desktop or touch applications. This is a static (Shared in VB.NET) property. Set this property at application startup. + + A enumeration value that specifies how scroll bars are displayed. + + + + Specifies a custom accent color. The custom accent color overrides the accent color setting in Windows OS (if the option is enabled). + + The accent color. + + + + Specifies the second accent color. “The Bezier” skin supports the second accent color. Other skins do not support the second accent color. + + The second accent color. + + + + Enables system DPI awareness mode for the current process. + + + + + Enables “Per-Monitor (v2)” DPI awareness mode for the process if it runs on versions greater than Windows 10 Creators Update (build 1703). On older Windows OS versions, enables system DPI awareness mode. + + + + + Gets or sets whether a control’s scroll bars appear on screen when an end-user moves the mouse pointer over the scrollable content. This is a static property. + + true if scroll bars appear on screen when an end-user moves the mouse pointer over the scrollable content; otherwise, false. + + + + Gets or sets whether the mouse wheel scrolls the control that is currently hovered over with the mouse pointer or the control that is currently focused. This property is in effect for controls that reside within an or . This is a static property. + + true, if the mouse wheel scrolls the control that is currently hovered with the mouse pointer; false, if the focused control is scrolled with the mouse wheel, regardless of the mouse cursor position.The default is true. + + + + Gets or sets whether to suppress accessibility events on mouse hover. This is a static property. + + + + + Gets or sets the rendering quality of vector images. + + A DevExpress.Utils.Svg.SvgImageRenderingMode enumeration value that specifies the rendering quality, such as HighSpeed or HighQuality, of vector images. Default equals HighQuality. + + + + Gets or sets the width of XtraForm and RibbonForm “thick” borders. Forms use thick borders when you enable the WindowsFormsSettings.FormThickBorder and\or WindowsFormsSettings.MdiFormThickBorder properties. + + The border thickness. + + + + Gets or sets a scale factor used to calculate the size of controls and distance between their elements in touch UI mode. This is a static (Shared in VB.NET) property. + + A scale factor used to calculate the size of controls and distance between their elements in touch UI mode. + + + + Gets or sets whether controls increase their size and the distance between their elements according to a scale factor. This is a static (Shared in VB.NET) property. + + if touch mode is enabled; otherwise, or . + + + + If this property is enabled, your application automatically applies the DevExpress “High Contrast” skin when Windows high contrast mode is on, and disables UI selectors that allow users to change skins and skin palettes. Otherwise, if this property is disabled, the active application skin does not depend on the actual state of Windows high contrast mode, and users can select any skin or skin palette. Windows high contrast mode is configured in the “Personalize | High contrast settings” screen. + + Specifies whether your application should automatically switch to the “High Contrast” skin when Windows high contrast mode is on. The DefaultBoolean.Default value is identical to DefaultBoolean.True. + + + + Gets or sets whether to use the Accent Color setting in Windows OS and apply it to all color palettes of vector skins except the High Contrast skin. + + DefaultBoolean.True to use the Accent Color setting in Windows OS and apply it to all color palettes of vector skins; otherwise, DefaultBoolean.False or DefaultBoolean.Default. + + + + Gets or sets whether your application tracks the Default App Mode setting in Windows OS and displays only light or dark color palettes in a Skin gallery. This setting works only in “WXI”, “Basic”, and “The Bezier” skins. + + DefaultBoolean.True to track the Default App Mode setting in Windows OS; otherwise, DefaultBoolean.False or DefaultBoolean.Default. + + + + Specifies whether WinForms data-aware controls should use the advanced Filter Editor Control that features a single-tab interface and enhanced text criteria builder. + + A DefaultBoolean enumerator value that specifies whether or not WinForms data-aware controls should use the advanced Filter Editor Control. + + + + Switches all TextEdit-based editors (except for and ) to Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + Specifies whether Advanced Mode is enabled. + + + + Gets or sets whether DevExpress controls and components that display Open File, Save File and Folder Browser dialogs should display standard WinForms dialogs or their DevExpress counterparts (, , and ). + + A enumeration value that specifies whether DevExpress controls and components should replace standard Open File, Save File and Folder Browser dialogs with skinnable DX Dialogs. + + + + Gets or sets whether to use the editor’s value (text) as accessible name (AccessibilityObject.Name). + + True to use the editor value (text) as accessible name; otherwise, False. + + + + Gets or sets whether DevExpress controls should use legacy Microsoft Active Accessibility (MSAA) or UIAutomation. See this link for more information on both technologies: Microsoft Active Accessibility and UI Automation Compared. + + true if DevExpress controls should use UIAutomation patterns; otherwise, false. + + + + A form that supports title bar and border skinning. The appearance settings of the XtraForm affect the look and feel settings of the DevExpress UI controls placed within it. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets the acrylic material’s opacity. The Acrylic effect is applied to an area occupied by the . + + Tint layer’s opacity. 0 for maximum transparency; 255 for no transparency. + + + + Gets or sets the color of the glow adorning effect applied to the form’s borders when the form is active. + + The color of the glow adorning effect applied to the form’s borders when the form is active. + + + + Gets or sets whether the form’s title bar and borders are painted using the current skin. This member supports the internal infrastructure and is not intended to be used directly from your code. + + true if the form’s title bar and borders are painted using the current skin; otherwise, false. + + + + Gets or sets whether an MDI bar is allowed for this form. This property is in effect for a parent MDI form, when the title bar skinning feature is enabled. + + true if the MDI bar is allowed; otherwise, false. + + + + Gets the appearance settings used to paint the form. + + An object which contains the form’s appearance settings. + + + + Applies the Acrylic accent (a semi-partial transparent background) to a control that resides within the current form. The Acrylic accent is only supported for certain controls. + + The target control that supports the Acrylic accent. + + + + Gets or sets the background color of the form’s client region. + + A structure which specifies the background color of the form’s client region. + + + + Specifies the background image for the form. + + A object that represents the background image. + + + + Gets or sets the background image layout as defined in the enumeration. + + A value that specifies the background image layout. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + An ImageLayout value. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + An Image object. + + + + Clears the Acrylic accent (a semi-partial transparent background) for a control that resides within the current form. The Acrylic accent is only supported for certain controls. + + The target control that supports the Acrylic accent. + + + + Gets or sets whether the form’s Close button (x) is visible. This property is in effect when the Form Title Bar Skinning feature is enabled. + + true if the form’s Close button (x) is visible; otherwise, false. + + + + Gets or sets whether the icon appears grayed out when the form is inactive. + + true if the ‘s icon appears grayed out when the form is inactive; false if the form’s icon appears in color. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This property supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + For internal use. + + A Boolean value. + + + + Gets or sets whether the Acrylic accent is enabled for the Accordion Control, Layout Control and Calendar Control when they reside within the current form. The property also enables the Reveal Highlight effect for the Accordion Control and Calendar Control. + + true, to enable the Acrylic effect; otherwise, false. + + + + Gets or sets the form’s font. + + A object which specifies the form’s font. + + + + Gets or sets the foreground color of the form’s client region. + + A structure which specifies the foreground color of the form’s client region. + + + + Gets or sets the form’s border effect. + + The form’s border adornment effect. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets a collection of images that can be inserted into the form’s caption using the image tag. This property is in effect when the Form Title Bar Skinning feature is enabled. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Allows you to specify the form’s caption and format it using HTML tags. The property is in effect when the Form Title Bar Skinning feature is applied. + + A string that specifies the form’s caption, formatted using HTML tags. + + + + For internal use. To specify the icon, use . + + The icon. + + + + Provides access to image settings that allow you to assign raster and vector images to XtraForms (instead of traditional .ico images). + + Provides access to form icon-related settings. + + + + Gets or sets the color of the glow adorning effect applied to the form’s borders when the form is not active. + + The color of the glow adorning effect applied to the form’s borders when the form is not active. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Contains settings that specify the look and feel of the current form and all DevExpress controls placed on the form. + + A object that stores look&feel settings for this . + + + + Gets or sets the maximum allowed client size for a form. + + A value. + + + + Gets or sets the form’s maximum size. + + A Size structure that specifies the form’s maximum size. + + + + Gets or sets the composite format string used to format the merged MDI parent and child captions. + + A string value that represents the composite format string used to format the merged MDI parent and child captions. + + + + Gets or sets the minimum allowed client size for a form. + + A value. + + + + Gets or sets the form’s minimum size. + + A Size structure that specifies the form’s minimum size. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Resets the XtraForm.BackColor property back to its default value. + + + + + Resets the XtraForm.ForeColor property back to its default value. + + + + + Resumes the usual layout logic. + + + + + Resumes the usual layout logic, optionally forcing an immediate layout of pending layout requests. + + true to execute pending layout requests; otherwise, false. + + + + Resumes painting the form whose painting had been suspended. + + + + + Shows the form as a modal dialog box with the specified owner. + + Any object implementing that represents the top-level window that will own the modal dialog box. + One of the values. + + + + Gets or sets whether the shows its icon. + + true if the shows its icon; otherwise, false. + + + + Gets or sets whether the caption of the currently active multiple-document interface (MDI) child is merged with the MDI parent caption, and shown in the form’s title bar. + + true if the MDI child caption is merged with the MDI parent caption; otherwise, false. + + + + Gets or sets the site of the . + + The ISite associated with the , if any. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Temporarily suspends the layout logic for the control. + + + + + Suspends painting the form. + + + + + Gets or sets the form’s caption. + + A string that specifies the form’s caption. + + + + Gets or sets the text displayed within a tab corresponding to the current form. This property is in effect when the current form represents an MDI child within an container. + + A string value. + + + + The base class for panels. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a value indicating whether the container enables the user to scroll to any control placed outside its visible boundaries. + + true if the auto-scrolling feature is enabled; otherwise, false. + + + + Gets or sets whether the panel is automatically resized according to the value of the XtraPanel.AutoSizeMode property. + + true if the panel’s auto-resizing feature is enabled; otherwise, false. + + + + Fires when the value of the XtraPanel.AutoSize property is changed. + + + + + Indicates the automatic sizing behavior of the panel. + + A value. + + + + Gets or sets the panel’s border style. + + A value that specifies the panel’s border style. + + + + Retrieves the size of a rectangular area into which the panel can be fitted. + + A custom-sized area for the panel. + A Size value that specifies a rectangle into which the panel can be fit. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Resets the XtraPanel.AutoSizeMode property to its default value. + + + + + Gets whether the XtraPanel.AutoSizeMode property should be serialized. + + true if the XtraPanel.AutoSizeMode property should be serialized; otherwise, false. + + + + Gets or sets a value indicating whether the user can focus this control using the TAB key. + + true if the user can focus this control using the TAB key; otherwise, false. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + The skinnable panel with built-in auto-scroll functionality. + + + + + Initializes a new instance of the class. + + + + + Gets or sets if end-users can scroll the by dragging its content. + + true if end-users can scroll the by dragging its content; otherwise, false. + + + + Gets or sets whether the XtraScrollableControl‘s view is automatically scrolled to completely display the active control if it is invisible, or partly visible. + + true to automatically scroll the view to completely display the active control if it is invisible, or partly visible; otherwise, false. + + + + Gets the control’s appearance settings. + + An object that contains appearance settings used to paint the control. + + + + Gets or sets whether the XtraScrollableControl enables the user to scroll to any controls placed outside its visible boundaries. + + true to enable auto-scrolling; otherwise, false. + + + + Gets or sets the size of the auto-scroll margin. + + A object that represents the height and width of the auto-scroll margin, in pixels. + + + + Gets or sets the minimum size of the auto-scroll. + + A object that represents the minimum height and width of the area through which a user can scroll, in pixels. + + + + Gets or sets the location of the auto-scroll position. + + A structure that represents the auto-scroll position, in pixels. + + + + Gets or sets the control’s background color. + + A value that specifies the control’s background color. + + + + Gets the rectangle that represents the XtraScrollableControl‘s view area. + + A object that represents the control’s view area. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the XtraScrollableControl.Scroll event fires when using the mouse wheel. + + true if the XtraScrollableControl.Scroll event fires when using the mouse wheel; otherwise, false. + + + + Gets or sets the control’s foreground color. + + A value that specifies the control’s foreground color. + + + + For internal use. + + + + + Gets the horizontal scrollbar’s settings. + + A DevExpress.XtraEditors.HorizontalScroll object that represents the horizontal scrollbar. + + + + Gets or sets whether the scroll direction is inverted when scrolling on touch devices via the pan gesture. + + true if the scroll direction is inverted; otherwise, false. + + + + Provides access to the Look And Feel and Skinning settings of this object. + + A object that stores look-and-feel settings. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. + + + + + Resets the XtraScrollableControl.BackColor property back to its default value. + + + + + Fires when the control’s view is scrolled. + + + + + Gets or sets the distance the XtraScrollableControl‘s view is scrolled when the user clicks one of the scroll buttons. + + An integer value that specifies the distance, in pixels, the control’s view is scrolled when the user clicks one of the scroll buttons. + + + + Scrolls the XtraScrollableControl‘s view to display the specified control. + + A descendant that represents the control which is invisible, or partly visible, within the XtraScrollableControl. + + + + Specifies the size of the auto-scroll margin. + + An integer value that specifies the width of the auto-scroll margin, in pixels. + An integer value that specifies the height of the auto-scroll margin, in pixels. + + + + Gets or sets the text associated with the control. + + A string value that specifies the text associated with the control. + + + + Gets the vertical scrollbar’s settings. + + A DevExpress.XtraEditors.VerticalScroll object that represents the vertical scrollbar. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with the specified , , and properties. + + The type of action that raises the event. This value is assigned to the property. + An integer value that specifies the new position of the scrollbar. This value is assigned to the XtraScrollEventArgs.NewValue property. + A value that specifies the scrollbar orientation. This value is assigned to the XtraScrollEventArgs.ScrollOrientation property. + + + + Initializes a new instance of the class with the specified , , , and properties. + + The type of action that raises the event. This value is assigned to the property. + An integer value that specifies the old position of the scrollbar. This value is assigned to the XtraScrollEventArgs.OldValue property. + An integer value that specifies the new position of the scrollbar. This value is assigned to the XtraScrollEventArgs.NewValue property. + A value that specifies the scrollbar orientation. This value is assigned to the XtraScrollEventArgs.ScrollOrientation property. + + + + Initializes a new instance of the class with the specified , , and properties. + + The type of action that raises the event. This value is assigned to the property. + An integer value that specifies the previous position of the scrollbar. This value is assigned to the XtraScrollEventArgs.OldValue property. + An integer value that specifies the new position of the scrollbar. This value is assigned to the XtraScrollEventArgs.NewValue property. + + + + Initializes a new instance of the class with the specified and properties. + + The type of action that raises the event. This value is assigned to the property. + An integer value that specifies the new position of the scrollbar. This value is assigned to the XtraScrollEventArgs.NewValue property. + + + + Gets or sets a value that specifies the position of a scrollbar after scrolling. + + An integer value that specifies the position of a scrollbar. + + + + Gets the position of a scrollbar before scrolling. + + An integer value that specifies the position of a scrollbar. + + + + Gets the scrollbar orientation. + + A value that specifies the scrollbar orientation. + + + + Gets the scrolling type that raises the event. + + The scrolling type that raises the event. + + + + A user control that supports look and feel and skinning technology. The appearance settings of this control affect the look and feel settings of the DevExpress UI controls placed within it. + + + + + Initializes a new instance of the class. + + + + + Gets the appearance settings used to paint the user control. + + An object which contains the user control’s appearance settings. + + + + Gets or sets the user control’s background color. + + A structure which specifies the user control’s background color. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets font settings applied to the control. + + A object that contains font settings. + + + + Gets or sets the control’s foreground color. + + A Color structure that specifies the control’s foreground color. + + + + Contains settings that specify the look and feel of the current and all DevExpress controls placed on it. + + An object that provides look-and-feel settings. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. + + + + + Resets the XtraUserControl.BackColor property back to its default value. + + + + + Sets the XtraUserControl.ForeColor property to Color.Empty. + + + + + Gets or sets the site of the . + + The ISite associated with the , if any. + + + + Contains classes that provide the basic functionality for the XtraPrinting library (bricks, pages, document). + + + + + Defines methods to print different controls using the XtraPrinting Library. + + + + + If implemented by a class, applies all changes made by the Property editor when implemented by a class. + + + + + If implemented by a class, determines whether the class provides the Property editor form. + + true if the class provides the Property editor; otherwise, false. + + + + If implemented by a class, returns a form which allows a user to set printing properties when implemented by a class. + + The Property editor form that enables users to customize print options of a control. + + + + If implemented by a class, cancels changes made by a user in the Property editor when implemented by a class. + + + + + If implemented by a class, invokes the help system for the Property editor when implemented by a class. + + + + + If implemented by a class, determines whether the help system is available for the Property editor when implemented by a class. + + true if the help system is available for the Property editor; otherwise, false. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.dll new file mode 100644 index 0000000..3c84323 Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.xml new file mode 100644 index 0000000..6fe8172 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.XtraEditors.v23.2.xml @@ -0,0 +1,39860 @@ + + + + DevExpress.XtraEditors.v23.2 + + + + + Contains utility classes used by DevExpress controls and components. + + + + + Contains classes that are used to implement context menus in DevExpress controls. + + + + + A menu item that allows you to embed an editor in a . + + + + + Initializes a new instance with the default settings. + + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + A descendant that determines the editor’s type and contains its properties. This parameter initializes the DXEditMenuItem.Edit property. + An item’s image. This parameter initializes the DXMenuItem.Image property. + An item’s image to be displayed when the item is disabled. This parameter initializes the DXMenuItem.ImageDisabled property. + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + A descendant that determines the editor’s type and contains its properties. This parameter initializes the DXEditMenuItem.Edit property. + An item’s image. This parameter initializes the DXMenuItem.Image property. + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + A descendant that determines the editor’s type and contains its properties. This parameter initializes the DXEditMenuItem.Edit property. + An event handler that will be invoked when the editor’s value is changed. This value is assigned to the DXEditMenuItem.EditValueChanged event. + An item’s image. This parameter initializes the DXMenuItem.Image property. + An item’s image to be displayed when the item is disabled. This parameter initializes the DXMenuItem.ImageDisabled property. + An integer value that is the editor’s width. This parameter initializes the DXEditMenuItem.Width property. + An integer value that is the editor’s height. This parameter initializes the DXEditMenuItem.Height property. + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + A descendant that determines the editor’s type and contains its properties. This parameter initializes the DXEditMenuItem.Edit property. + An event handler that will be invoked when the editor’s value is changed. This value is assigned to the DXEditMenuItem.EditValueChanged event. + An item’s image. This parameter initializes the DXMenuItem.Image property. + An item’s image to be displayed when the item is disabled. This parameter initializes the DXMenuItem.ImageDisabled property. + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + A descendant that determines the editor’s type and contains its properties. This parameter initializes the DXEditMenuItem.Edit property. + + + + Initializes a new class instance with the specified settings. + + A string value that specifies the item’s caption. This parameter initializes the DXMenuItem.Caption property. + + + + Gets or sets the object that determines the editor’s type and contains its properties. + + A descendant that determines the editor’s type and contains its properties. + + + + Specifies the editor’s value. + + An object that is the editor’s value. + + + + Occurs after the DXEditMenuItem.EditValue property’s value has been changed. + + + + + Gets or sets the editor’s height. + + An integer value that is the editor’s height. + + + + Gets or sets the editor’s width. + + An integer value that is the editor’s widhth. + + + + Provides data for the event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets whether the event is handled. If the event is handled, the browser does not open. + + true if the event is handled; otherwise, false. + + + + Contains the classes that maintain the AlertControl’s infrastructure. + + + + + Represents a button within an alert window. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified image and button style. + + A object that specifies the image to be displayed in a button. This value is assigned to the AlertButton.Image property. + An value that specifies the button style. This value is assigned to the AlertButton.Style property. + + + + Initializes a new instance of the class with the specified image. + + A object that specifies the image to be displayed in a button. This value is assigned to the AlertButton.Image property. + + + + Gets or sets the bounds of the button. + + A structure specifying the button’s rectangle. + + + + Disposes of the current object and releases all the allocated resources. + + + + + Gets or sets the pressed state of the button, This option is in effect when the button functions as a check button (the AlertButton.Style property is set to AlertButtonStyle.CheckButton). + + A Boolean value that specifies the button’s pressed state. + + + + Returns the button’s size. + + A structure that specifies the button’s size. + + + + Gets or sets the button’s hint. + + A string that specifies the button’s hint. + + + + Gets or sets an image displayed within the button + + A object that specifies the button’s image. + + + + Gets or sets an image displayed when the current button functions as a check button and it’s in the pressed state. + + A object that specifies the image representing the button’s pressed state. + + + + Gets or sets the index of an image in the AlertControl.Images collection, referring to the image displayed when the button functions as a check button and it’s in the pressed state. + + An integer value that specifies the index of an image in the AlertControl.Images collection. + + + + Gets or sets the index of an image in the AlertControl.Images collection, referring to the image displayed by the button. + + An integer value that specifies the index of an image in the AlertControl.Images collection. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.XtraBars.Alerter.AlertButtonImageOptions object that stores image-related options. + + + + Gets the source of images for buttons in alert windows. + + An object representing the source of images for buttons in alert windows. + + + + Gets or sets the button’s name. + + A string that specifies the button’s name. + + + + The method is called when the button is clicked. + + + + + Gets the alert window that displays the current button. + + An AlertFormCore object that displays the current button. + + + + Gets whether the current button is one of the predefined buttons (Close, Pin or Dropdown). + + true if the current button is one of the predefined buttons; otherwise, false. + + + + Emulates changing a button’s check state, as if the button were clicked by the mouse. + + true to check the button; false to uncheck the button. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the button’s state. + + An AlertButtonState value that specifies the button’s state. + + + + Gets or sets the button’s style. + + An value that specifies the button’s style. + + + + Returns the textual representation of the button. + + A string representation of the button. + + + + Gets or sets the button’s visibility. + + A Boolean value that specifies the button’s visibility. + + + + Represents a collection of buttons for alert windows. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified owner. + + An owner of the current collection. + + + + Adds a new button to the collection. + + An to be added to the collection. + An integer value that specifies the index of this button in the current collection. + + + + Provides access to the settings of the Close Button, used to close an alert window. + + An object that contains corresponding settings. + + + + Gets the number of custom buttons in the current collection. + + An integer value that specifies the number of custom buttons in the current collection. + + + + Disposes of the current object and releases all the allocated resources. + + + + + Locates the button in the collection that has the specified hint. + + A string that specified the hint of a button to be located. + An object that has been located; null if no button with the specified hint has been located. + + + + Provides indexed access to the buttons in the collection. + + An integer value that specifies the index of the button to be returned from the collection. + An object stored at the specified index in the collection. + + + + Provides access to the buttons in the collection by their names. + + A string that specifies the name of the button to be located. + An object with the specified name. + + + + Provides access to the settings of the Pin Button, used to pin an alert window. + + An object that contains corresponding settings. + + + + Gets the number of predefined buttons in the current collection. + + An integer value that specifies the number of predefined buttons in the current collection. + + + + Contains values that specify the style of custom buttons in alert windows. + + + + + A button functions as a regular button, producing the AlertControl.ButtonClick event when clicked. + + + + + A button functions as a check button, producing the AlertControl.ButtonDownChanged event when its pressed state is changed. + + + + + Contains values that specify the position of the control buttons in alert windows. + + + + + The control buttons are displayed at the right edge of an alert window. + + + + + The control buttons are displayed at the top edge of an alert window. + + + + + Contains values that specify the appearance speed of alert windows. + + + + + The alert window’s appearance speed is fast. + + + + + The alert window’s appearance speed is moderate. + + + + + The alert window’s appearance speed is slow. + + + + + Contains values that specify the position on screen at which alert windows are displayed. + + + + + An alert window appears at the bottom left corner of the screen. + + + + + An alert window appears at the bottom right corner of the screen. + + + + + An alert window appears at the top left corner of the screen. + + + + + An alert window appears at the top right corner of the screen. + + + + + Enumerates alert window animation effects. + + + + + For ShowAnimationType and HideAnimationType properties, the “Default” value means alerts should be displayed or hidden according to the value of the FormShowingEffect property. For the FormShowingEffect property itself, the “Default” value corresponds to the “FadeIn” effect. + + + + + An alert window is displayed and/or hidden with a fade-in effect. + + + + + An alert window is displayed and/or hidden by sliding horizontally onto the screen. + + + + + An alert window is displayed and/or hidden by sliding vertically onto the screen. + + + + + Alerts are displayed and/or hidden with no animation effects. + + + + + Alerts show be shown on-screen and (or) hidden using the Reveal animation (a combination of fade in and zoom in/out effects). + + + + + An alert window is displayed (or hidden) by gradually increasing its width from 0 to 100% (or vice versa). + + + + + An alert window is displayed (or hidden) by gradually increasing its height from 0 to 100% (or vice versa). + + + + + Contains information to be displayed in an alert window. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the alert window caption. + A String value that is the alert window text. + true if the alert window should be closed on click; otherwise, false. + + + + Initializes a new instance of the class with the window caption, text and image. + + A string that specifies the caption of an alert window. This value is assigned to the AlertInfo.Caption property. + A string that specifies the text of an alert window. This value is assigned to the AlertInfo.Text property. + An image to be displayed in an alert window. This value is assigned to the AlertInfo.Image property. + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the alert window caption. + A String value that is the alert window text. + A String value that is the alert window text, displayed only when hovered (see the AlertInfo.HotTrackedText property). + An Image that is the alert window icon. + An object that is the unique ID associated with this . + true if the alert window should be closed on click; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A string that specifies the caption of an alert window. This value is assigned to the AlertInfo.Caption property. + A string that specifies the text of an alert window. This value is assigned to the AlertInfo.Text property. + A string that specifies the text of an alert window, which is in effect when the text is hot-tracked. This value is assigned to the AlertInfo.HotTrackedText property. + An image to be displayed in an alert window. This value is assigned to the AlertInfo.Image property. + Any custom data to be associated with the current object. This value is assigned to the AlertInfo.Tag property. + + + + Initializes a new instance of the class with the specified window caption, text, image and the text that is to be displayed when the text area is hot-tracked. + + A string that specifies the caption of an alert window. This value is assigned to the AlertInfo.Caption property. + A string that specifies the text of an alert window. This value is assigned to the AlertInfo.Text property. + A string that specifies the text of an alert window, which is in effect when the text is hot-tracked. This value is assigned to the AlertInfo.HotTrackedText property. + An image to be displayed in an alert window. This value is assigned to the AlertInfo.Image property. + + + + Initializes a new instance of the class with the specified window caption, text, and the text that is to be displayed when the text area is hot-tracked. + + A string that specifies the caption of an alert window. This value is assigned to the AlertInfo.Caption property. + A string that specifies the text of an alert window. This value is assigned to the AlertInfo.Text property. + A string that specifies the text of an alert window, which is in effect when the text is hot-tracked. This value is assigned to the AlertInfo.HotTrackedText property. + + + + Initializes a new instance of the class with the specified window caption and text. + + A string that specifies the caption of an alert window. This value is assigned to the AlertInfo.Caption property. + A string that specifies the text of an alert window. This value is assigned to the AlertInfo.Text property. + + + + Gets or sets whether or not an alert window associated with this object is automatically closed on click. + + true if an alert window associated with this object is automatically closed on click; otherwise, false. + + + + Gets or sets the caption of an alert window. + + A string that specifies the caption of an alert window. + + + + Gets or sets the text of an alert window, displayed when the text is hot-tracked. + + A string that specifies the hot-tracked text for an alert window. + + + + Gets or sets an image to be displayed in an alert window. + + A object that specifies an image to be displayed in an alert window. + + + + Provides access to properties that allow you to set up raster and vector images for this class descendant. + + An DevExpress.XtraBars.Alerter.AlertInfoImageOptions object that provides access to image-related settings. + + + + Gets or sets the notification vector icon for this notification. + + The notification’s vector icon. + + + + Gets or sets custom data associated with the current object. + + An object that represents custom data associated with the current object. + + + + Gets or sets the text of an alert window. + + A string that specifies the text of an alert window. + + + + Contains classes that implement docking functionality. + + + + + Lists values specifying the position of the tabs in a tab container. + + + + + The tabs are located across the bottom of the tab container. + + + + + + The tabs are located along the left side of the tab container. + + + + + + The tabs are located along the right side of the tab container. + + + + + + The tabs are located across the top of the tab container. + + + + + + Contains editor classes that implement the functionality for corresponding controls. + + + + + The Area view of the chart range control client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A Single value that specifies the newly created object’s scale factor. + + + + Specifies the opacity (0-255) of the chart range control client area view. + + A value from 0 (transparent) to 255 (opaque). + + + + Allows you to create messages and dialogs that automatically close when a timer expires. See the XtraBaseArgs.AutoCloseOptions property for examples. + + + + + Creates a new instance of the AutoCloseOptions class with default settings. + + + + + Gets or sets the timer (in milliseconds) that automatically closes the dialog when it expires. See the XtraBaseArgs.AutoCloseOptions property for examples. + + The timer duration (in milliseconds). + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + If the AutoCloseOptions.Delay timer was set to a value different from zero, the ShowTimerOnDefaultButton property allows you to display the remaining timer duration on the default dialog button. See the XtraBaseArgs.AutoCloseOptions property for examples. + + true, to display the remaining time on the default button; otherwise, false. + + + + Displays a bar code. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a value that specifies whether the BarCodeControl.Module property value should be calculated automatically based upon the bar code’s size. + + true if the bar code’s module is calculated automatically; otherwise, false. + + + + Gets or sets the byte array to be coded into the PDF417 or ECC200 bar code. + + An array of System.Byte values to be coded using the bar code’s symbology. + + + + Creates an image of the bar code in the PNG format with a resolution of 96 DPI. + + A object, specifying the currently displayed bar code as an image. + + + + Creates an image of the bar code with the specified image format and resolution. + + A object specifying the image format, such as PNG, BMP, or GIF, in which the bar code should be returned. + An integer value specifying the horizontal and vertical resolution, in dots per inch, for the image to return. + A object specifying the currently displayed bar code as an image. + + + + Creates an image of the bar code with the specified image format and a resolution of 96 DPI. + + A object specifying the image format, such as PNG, BMP, or GIF, in which the bar code should be returned. + A object specifying the currently displayed bar code as an image. + + + + Saves the bar code as an image to a stream with the specified image format and resolution. + + The where the image will be saved. + A object specifying the format, such as PNG, BMP, GIF, of the saved image. + An integer value specifying the horizontal and vertical resolution, in dots per inch, of the saved image + + + + Gets or sets the BarCodeControl‘s foreground color. + + The BarCodeControl‘s foreground color. + + + + Gets or sets the bar code’s horizontal alignment. + + A enumeration value that specifies the bar code’s horizontal alignment. + + + + Gets or sets the text’s horizontal alignment. + + A enumeration value that specifies the text’s horizontal alignment. + + + + Gets or sets the width of the narrowest bar or space, in pixels. + + The width of the narrowest bar or space, in pixels. + + + + Gets or sets the bar code’s orientation. + + A enumeration value that specifies the bar code’s orientation. + + + + Gets or sets whether or not the control’s Text is displayed along with the bar code. + + true if the text is displayed; otherwise, false. + + + + Gets or sets the symbology (code type) for the bar code and the text. + + A class descendant that defines the symbology for the current control. + + + + Indicates whether or not the bar code is correctly rendered. + + A enumeration value, identifying the error (BarCodeError.None if the bar code validation succeeds). + + + + Gets or sets the bar code’s vertical alignment. + + A enumeration value that specifies the bar code’s vertical alignment. + + + + Gets or sets the text’s vertical alignment. + + A enumeration value that specifies the text’s vertical alignment. + + + + Serves as a base for button controls. + + + + + Creates an instance of the class. + + + + + Provides access to the appearance settings applied when the current button is disabled. + + An object that specifies the appearance settings applied when the current button is disabled. + + + + Provides access to the appearance settings applied when the mouse pointer passes over the current button. + + An object that specifies the appearance settings applied when the current button is hovered over with the mouse pointer. + + + + Provides access to the appearance settings applied when the current button is clicked. + + An object that specifies the appearance settings applied when the current button is clicked. + + + + Gets or sets the button’s background color. + + A structure which specifies the button’s background color. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + An Action that specifies whether this is currently enabled. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An Action that specifies whether this is currently enabled. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An Action that uses the boolean function to specify whether or not this is currently enabled. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + An Action that specifies whether this is currently enabled. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An Action that specifies whether this is currently enabled. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + This member is not supported. + + A enumeration member specifying the border style of the button. + + + + Gets or sets the style of the button control. + + A enumeration member specifying the button style. + + + + Calculates the button’s size needed to fit its content. + + A System.Drawing.Graphics object used to paint. + A System.Drawing.Size object representing the button’s size that will best fit its content. + + + + Calculates the button size required to fit its content, but not exceeding the specified maximum width. + + The value that limits the width. + A System.Drawing.Size object representing the button size that best fits its content, but whose width does not exceed the specified value. + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets or sets a value that is returned to the parent form when the button is clicked. + + A DialogResult enumeration member specifying the value that is returned to the parent form when the button is clicked. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + true if the button should behave as the default button; otherwise false. + + + + Gets or sets the button’s paint style. + + The button’s paint style. + + + + Responds to button clicks. + + + + + Resets the BaseButton.BackColor property back to its default value. + + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or the button. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether the tooltip is anchored relative to the mouse pointer or the button. + + + + The base class for and . + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the editor’s width is changed to display the editor’s content in its entirety. This property is in effect when the editor resides within a . + + true if auto-size mode is enabled; otherwise, false. + + + + Gets or sets the style used to draw the check editor’s border. + + A enumeration value identifying the style used to draw the check editor’s border. + + + + Calculates the minimum size the control needs to be to contain its contents. + + A System.Drawing.Size object representing the minimum size of the control that will best fit its content. + + + + Gets the editor’s class name. + + A System.String object identifying the class name of the current editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Retrieves the size of a rectangular area into which the control will fit. + + The custom-sized area for the control. + A System.Drawing.Size value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the size of a rectangular area into which the control can fit. + + A System.Drawing.Size structure specifying the control’s minimum size. + + + + Gets an object containing properties, methods and events specific to a check editor. + + A object instance containing settings for the control. + + + + Gets or sets the text label associated with a check editor. + + A System.String value representing the text label associated with a check editor. + + + + Changes the state of a check editor. + + + + + Serves as the base for the class. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether check items in the checked list box should support three check states rather than two. + + true if the check items are able to display three check states; otherwise, false. + + + + Checks all the items in the list box. + + + + + Gets the collection of indexes corresponding to checked items. + + A CheckedIndexCollection object representing the collection of indexes corresponding to checked items. + + + + Gets the collection of checked item values. + + A CheckedItemCollection object representing the collection of checked item values. + + + + Returns the number of checked items in the BaseCheckedListBoxControl.Items collection. + + An integer value that specifies the number of checked items. + + + + Gets or sets the name of the data source field that provides check states for listbox items. + + A string value specifying a field name in the data source. + + + + Occurs when the BaseCheckedListBoxControl.CheckMember property value is changed. + + + + + Gets or sets whether one or two mouse clicks are required to toggle the check state of an unfocused (unselected) item. + + true if a single mouse click is required to toggle the check state of an unfocused (unselected) item; false if two mouse clicks are required. + + + + Checks all selected (highlighted) items. + + + + + Gets or sets a value that determines the look and feel of the check boxes. This property is not supported when listbox items are rendered based on Item Templates + + A enumeration value specifying the look and feel of the check box. + + + + Occurs when the field value is fetched from the data source and then posted back. + + + + + Enables you to sort list items in custom order. + + + + + Gets a value indicating whether the item is checked. + + An integer value representing the zero-based index of the item. + true if the item is checked; false if unchecked or in the indeterminate state. + + + + Gets the check state of the item specified by its index. + + An integer value representing the zero-based index of the item. + A CheckState enumeration member representing the item’s check state. CheckState.Unchecked if the item’s index is negative or exceeds the last available index. + + + + Enables you to disable specific items, in bound mode. + + + + + Inverts the check state for each item in the BaseCheckedListBoxControl.Items collection. + + + + + Returns whether all selected (highlighted) items are checked. + + true if all selected items are checked; otherwise, false. + + + + Fires after an item’s check state changes. + + + + + Fires before an item’s check state changes and allows you to cancel the action. + + + + + Access the item collection, when the control is not bound to a data source. + + A object representing the items collection displayed within the CheckedListBoxControl. + + + + Gets or sets a custom image representing check boxes in the checked state. This property is in effect if the BaseCheckedListBoxControl.CheckStyle property is set to CheckStyles.UserDefined. + + An Image representing check boxes in the checked state. + + + + Gets or sets a custom image representing check boxes in the intermediate state. This property is in effect if the BaseCheckedListBoxControl.CheckStyle property is set to CheckStyles.UserDefined. + + An Image representing check boxes in the intermediate state. + + + + Gets or sets a custom image representing check boxes in the unchecked state. This property is in effect if the BaseCheckedListBoxControl.CheckStyle property is set to CheckStyles.UserDefined. + + An Image representing check boxes in the unchecked state. + + + + Gets or sets whether or not users can check or uncheck control items. Items remain selectable even when the ReadOnly property is set to true. + + Specifies whether users are allowed to check and uncheck items. + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + Occurs when the items collection or data source changes. + + + + + Sets the specified item’s state to checked or unchecked. + + An integer value that specifies the zero-based index of the item whose check state should be changed. + true, if the item is checked; false, if the item is unchecked. + + + + Sets the check state of the item. + + An integer value representing the zero-based index of the item. + A CheckState enumeration member specifying the new check state of the item. + + + + Toggles the state of the item at the specified index. + + An zero-based integer value which represents the index of the item whose state should be toggled. + + + + Inverts the check states of selected items. + + + + + Unchecks all the items. + + + + + Unchecks all selected (highlighted) items. + + + + + Implements the functionality common for all controls in the library. + + + + + Creates an instance of the class. + + + + + Gets or sets whether HTML formatting is allowed in the control’s regular tooltips. + + , to enable HTML formatting in regular tooltips; , to disable; , to use the ToolTipController.AllowHtmlText setting. + + + + When a control is added to a , this property specifies whether the control’s width is changed to display its content in its entirety. + This member is supported by individual descendant of the class. + + true if auto-size mode is enabled; otherwise, false. + + + + Gets or sets the control’s border style. + + A enumeration value specifying the control’s border style. + + + + Calculates the minimum size sufficient to fit the content. + + A Size structure that specifies the minimum size sufficient to fit the content. + + + + Returns an object which implements the accessibility information. + + A BaseAccessibility object. + + + + Returns the object which contains the internal information used to render the control. + + A DevExpress.XtraEditors.ViewInfo.BaseControlViewInfo descendant which contains the internal information used to render the control. + + + + Gets a value indicating whether the control is currently in design mode. + + true if the control is in design mode; otherwise, false. + + + + Gets whether the control is being initialized. + + true if the control is being initialized; otherwise, false. + + + + Provides access to the object containing the control’s look and feel settings. + + A object containing the control’s look and feel settings. + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + Removes the object that has been assigned to the current control. + + + + + Returns scale multipliers that are currently applied to a control’s original width and height. + + A value that specifies scale multipliers. + + + + Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. + + true to display tooltips; otherwise, false. + + + + Gets or sets the style controller component that provides style settings for this control. + + An object that implements the DevExpress.XtraEditors.IStyleController interface which provides style settings for the current control. + + + + Gets or sets a for the current control. + + A object associated with the control. + + + + Gets or sets a regular tooltip’s text content. + + A string which specifies the text content of a regular tooltip. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control. + + The component controlling the appearance and behavior of hints displayed for this control. + + + + Gets or sets the type of the tooltip icon. + + A enumeration value. + + + + Gets or sets a regular tooltip’s title. + + A value which specifies a regular tooltip’s title. + + + + The base class for controls that implement the ability to edit date-time values. + + + + + Initializes a new instance of the class with default settings. + + + + + Serves as the base for all editors that can be used for inplace (such as within the XtraGrid) editing. + + + + + Creates an instance of the class. + + + + + Displays the XtraEditors library’s about box. + + + + + Gets or sets the default action description of the editor for use by accessibility client applications. + + A string which specifies the default action description of the editor for use by accessibility client applications. + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A System.Windows.Forms.Control object representing the control containing the current editor. + A System.Drawing.Point object representing the coordinates of a mouse click. + true, a mouse click is allowed; otherwise, false. + + + + Gets or sets the background color of an enabled editor. + + A object specifying the editor’s background color when it is not disabled. + + + + This event is not supported by the class. + + + + + Gets the BindingManagerBase object. + + A BindingManagerBase object managing all binding controls that are bound to the same data source and data member. null (Nothing in Visual Basic) if no data source is bound. + + + + Gets or sets the editor’s border style. + + A enumeration value specifying the editor’s border style. + + + + Calculates the minumum height of the editor. + + The minimum height of the editor, in pixels. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + + + For internal use. + + + + + Gets or sets the context menu for the editor. + + A System.Windows.Forms.ContextMenu object representing the context menu for the editor. + + + + Enables custom display text to be provided for an editor. + + + + + Gets or sets the default error icon. + + A object that specifies the default error icon. + + + + Gets or sets the location of the default error icon in relation to the editor. + + An enumeration value that specifies the location of the default error icon in relation to the editor. + + + + Gets a set of options that allow you to assign and customize the default icon displayed when an error is associated with the editor. + + A object that stores properties that allow you to assign and customize the default icon displayed when an error is associated with the editor. + + + + Clears selection within the editor. + + + + + Performs editor value validation. + + true if the editor value has been validated; otherwise, false. + + + + Validates the editor. + + A enumeration value that specifies how a dropdown editor’s popup window was closed. + true if the editor’s value is valid; otherwise, false. + + + + Tests whether the editor or its popup window has focus. + + true if the editor or its popup window has focus; otherwise false. + + + + Gets the editor’s class name. + + A string value identifying the editor’s class name. + + + + Gets or sets the editor’s value. + + An object representing the editor’s value. + + + + Fires immediately after the edit value has been changed. + + + + + Fires when the editor’s value is about to change. + + + + + Gets or sets whether focus is moved to the next control (according to the tab order) when an end-user presses ENTER. + + true if focus is moved to the next control (according to the tab order) when an end-user presses ENTER; otherwise, false. + + + + Gets or sets an icon displayed when an error is associated with the editor. + + A object that specifies the error icon. + + + + Gets or sets the alignment of the icon displayed when an error is associated with the editor. + + An value that specifies the error icon’s alignment. + + + + Gets a set of options that allow you to assign and customize an icon displayed when an error is associated with the editor. + + A object that stores properties that allow you to assign and customize an icon displayed when an error is associated with the editor. + + + + Gets or sets the tooltip displayed when the mouse pointer hovers over the error icon. + + A string value that specifies the tooltip displayed when the mouse pointer hovers over the error icon. + + + + Gets or sets the font used to display editor contents. + + A object specifying the font used to display editor contents. + + + + This event is not supported by the class. + + + + + Gets or sets the editor content’s foreground color. + + A structure specifying the editor content’s foreground color. + + + + This event is not supported by the class. + + + + + Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). + + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A value. + + + + Gets or sets the inplace type of an editor. + + A enumeration member specifying the editor inplace type. + + + + Enables an appropriate response to be provided when invalid values are entered. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether the editor is active. + + true if the editor is active; otherwise, false. + + + + Gets a value indicating whether the editor is being loaded. + + true if the editor is being loaded; otherwise, false. + + + + Gets or sets whether the editor’s value has been modified since the editor last received focus or since it was last validated. + + true if the editor’s value has been modified; otherwise, false. + + + + Returns a value indicating whether a particular key will be processed by the editor or passed to its container. + + A object specifying the key to process. + true if the pressed key will be processed by the editor; otherwise, false. + + + + This member supports the internal editors library infrastructure and is not intended to be used from your code. + + true if a container control needs to focus the editor; otherwise, false. + + + + Gets whether the specified value is the “Non-loaded Value”. This property is in effect when asynchronous data binding is used. + + A value to be tested. + true if the specified value is the “Non-loaded Value”; otherwise, false. + + + + Checks whether a control is a text editor. + + The current control. + true if the current control is a text editor; otherwise, false. + + + + Gets an object containing the editor’s look and feel settings. + + A object containing the editor’s look and feel settings. + + + + Gets or sets an object that controls the look and feel of the popup menus. + + An object that controls the look and feel of the popup menus. + + + + Fires when the user starts to modify the edit value. + + + + + Gets the last successfully validated value. + + An object representing the last value that was successfully validated. + + + + This property is not supported by the class. + + A Padding value. + + + + Converts an input value (the one that is entered by an end-user or assigned in code) to the value to be stored by the editor. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets an object containing properties, methods and events specific to the editors. + + A object containing settings relating to all editors. + + + + Fires immediately after any editor’s property value has changed. + + + + + Fires when the help is provided to accessibility applications. + + + + + Provides ability to specify whether the key pressed in the editor is processed by the editor or a container control (, , etc.) that displays this editor. + + + + + Gets or sets whether the editor’s value cannot be changed by end-users. + + true if end-users cannot modify the editor’s value; otherwise, false. + + + + Resets the editor’s selection and cursor position. + + + + + Resets the BaseEdit.BackColor property back to its default value. + + + + + Resets the BaseEdit.ForeColor property back to its default value. + + + + + In descendant classes, clears the selection. + + + + + Selects the editor’s entire content. + + + + + Sends the specified message to the active editor. + + A to be sent. + A KeyPressEventArgs object that will be passed to the editor’s KeyPress event. + + + + Raises the KeyDown event. + + A object providing data for the event. + + + + Raises the KeyUp event. + + A object providing data for the event. + + + + Raises the RepositoryItem.MouseDown event. + + A structure specifying the mouse pointer coordinates. + A bitwise combination of enumeration values specifying the pressed mouse buttons. + + + + Raises the RepositoryItem.MouseDown event. + + A object providing data for the RepositoryItem.MouseDown event. + + + + Raises the RepositoryItem.MouseUp event. + + A structure that specifies the mouse pointer coordinates. + A enumeration value that specifies which mouse button was pressed. + + + + This method is used internally when using editors inplace and is not intended to be called in your code. + + An object supporting the IPopupServiceControl interface. + + + + This member supports the internal .NET Framework infrastructure, and is not intended to be used directly from your code. + + + + + This method supports the internal .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Gets or sets whether an end-user can focus this control using the TAB key. + + true if an end-user can focus the control using the TAB key; otherwise, false. + + + + Gets or sets the text displayed by the editor. + + A string value representing the text displayed by the editor. + + + + Gets or sets whether the tooltip is anchored relative to the mouse cursor or relative to the editor. This property is not in effect if you handle the ToolTipController.GetActiveObjectInfo event. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether the tooltip is anchored relative to the mouse cursor or relative to the editor. By Default, the behavior depends on the ToolTipController.ToolTipAnchor property. + + + + Contains a set of options that allow you to specify and customize an error icon. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets the alignment of the error icon relative to the editor. + + A value that specifies the alignment of the error icon relative to the editor. + + + + Serves as a base for class. + + + + + Gets the image displayed within the specified item. + + An integer value representing the zero-based index of the item. + A object value specifying the image displayed within the specified item. -1 if no item is found. + + + + Gets the index of the image displayed within the specified item. + + An integer value representing the zero-based index of the item. + An integer value representing the zero-based index of the image displayed within the specified item. -1 if no item is found. + + + + Returns the image options of the item with the specified index. + + An integer value that specifies the zero-based index of the item whose image options will be obtained. + An ImageOptions object that specifies the image options of the item with the specified index. + + + + Returns the image size of the item with the specified index. + + An integer value that specifies the zero-based index of the item whose image will be obtained. + A Size structure that specifies the image size of the item with the specified index. + + + + Specifies the alignment of the image displayed within the item. + + A enumeration member specifying the image alignment. + + + + Gets or sets the name of the data source field that provides image indexes for listbox items. This property is not supported when listbox items are rendered based on Item Templates. + + A string value specifying the name of the data source field whose contents represent image indexes. + + + + Occurs after the BaseImageListBoxControl.ImageIndexMember property value has been changed. + + + + + Gets or sets the source of images to be displayed within the items. + + An object which is the source of images. + + + + Gets or sets the name of the data source field that provides images for listbox items. This property is not supported when listbox items are rendered based on Item Templates. + + A string value specifying the name of the data source field whose contents represent images. + + + + Occurs after the BaseImageListBoxControl.ImageMember property value has been changed. + + + + + Accesses the item collection, when the control is not bound to a data source. + + An object representing the items collection. + + + + Serves as the base for , , , and classes. + + + + + Creates a new object. + + + + + Adds new items that represent elements of the specified enumeration to the control, allowing you to specify whether enumeration constant names or integer values are assigned to the item values. + + The type of the required enumeration. + true if enumeration underlying integer values are assigned to the item values; otherwise, false. + + + + Adds new items that represent elements of the specified enumeration to the control. + + The type of the required enumeration. + + + + Adds new items that represent elements of the specified enumeration to the control. + + + + + Adds new items that represent elements of the specified enumeration to the control. Allows you to customize item descriptions and specify whether underlying integer values are assigned to the item values. + + A System.Converter delegate that generates item descriptions to be displayed. + true, if values for generated items should store numeric enumerator values; false, if these values should store constant enumerator names instead. + The type of the required enumeration. + + + + Adds new items that represent elements of the specified enumeration to the control, allowing you to customize item descriptions. + + A System.Converter delegate that generates item descriptions. + + + + Gets or sets whether HTML tags can be used to format the text of the control’s items. + + A value that specifies whether HTML tags can be used to format the text of the control’s items. + + + + Provides access to the appearance settings used to paint list items when the control is disabled. + + A object that specifies the appearance settings used to paint list items when the control is disabled. + + + + Provides access to the appearance settings used to paint hot tracked list items. + + An object specifying the appearance settings used to paint hot tracked list items. + + + + Provides access to the appearance settings used to paint list items in the selected state. + + An object that specifies the appearance settings used to paint list items in the selected state. + + + + Gets or sets the control’s background color. + + A value that specifies the control’s background color. + + + + Locks the object by preventing visual updates of the object and its elements until the EndUpdate method is called. + + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and binds it to this HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The ID of the HTML element to which the found command should be bound. + A Func delegate that passes an Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from its target HTML element. + + + + Binds the specific parameterized command to the target HTML element. + + An Object that is the command to be bound to this HTML element. + The ID of the HTML element to which the target command should be bound. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from its target HTML element. + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to the HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The ID of the HTML element to which the target command should be bound. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Gets or sets column width when the BaseListBoxControl.MultiColumn setting is enabled. + + An integer value representing column width in pixels. 0 if the column width is automatically calculated. + + + + Fires when a context button is clicked. + + + + + Provides access to the settings applied to the context buttons displayed in the control. + + A DevExpress.Utils.SimpleContextItemCollectionOptions object that comprises settings applied to the context buttons displayed in the control. + + + + Provides access to the collection of context buttons displayed in the control. + + A ContextItemCollection object that represents the collection of context buttons. + + + + Fires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes. + + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Allows you to draw custom content within the empty list box. + + + + + Allows you to draw custom scrollbars, or highlight specific positions on the scrollbars. + + + + + Enables custom display text to be provided for control items. + + + + + Allows you to assign custom templates to listbox items. + + + + + Allows you to customize the context buttons for individual items. + + + + + Allows you to customize templated items dynamically. + + + + + Gets or sets the data source that provides items to display in the control. + + A data source object whose data is displayed by the ListBox control. + + + + Occurs immediately after the BaseListBoxControl.DataSource property value has been changed. + + + + + The default value for the BaseListBoxControl.ShowToolTipForTrimmedText property. Returns false. + + + + + Gets or sets the name of the data source field that specifies display text for listbox items. This property is not supported when listbox items are rendered based on Item Templates. + + A string value specifying a field name in a data source. + + + + Occurs immediately after the list box control display member has been changed. + + + + + Provides the ability to custom paint items displayed within the list box control. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Searches for the first list box item in the specified direction from the specified index, using a cusom algorithm. + + An integer value providing the zero-based index of the start item. + true to search to the end of the item list; false to search to the beginning of the item list. + A delegate that is called when searching for a list box item. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Returns the index of the specified item. + + An object which represents an item whose index is returned. + An integer value which specifies the item’s position within the collection. -1 if the item isn’t found. + + + + Searches for the first list box item in the specified direction from the specified index, and starting with a specific string. + + A string value representing the search text. + An integer value providing the zero-based index of the start item. + true to search to the end of the item list; false to search to the beginning of the item list. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Finds the first item in the list box control which starts with the specified string. The search starts at a starting index specified by the parameter. + + A string value providing the search text. + An integer value providing the zero-based index of the start item. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Finds the first item in the list box control starting with the specified string. + + A string value representing the search text. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Finds the first item which matches the specified string exactly. + + A string value specifying the search text. + An integer value representing the zero-based index of the first item to be searched. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Finds the first item in the list box control which matches the specified string exactly. + + A string value specifying the search text. + An integer value representing the zero-based index of the first item found. -1 if no item is found. + + + + Forces the control to finish its initialization. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets an item’s display value. + + A zero-based integer specifying the item by its position within the collection. + An object representing the item’s value. The String.Empty value if the item index provided is invalid. + + + + Gets an item at the specified position. + + An integer value representing the zero-based index of an item to be returned. + An object representing an item at the specified position. null (Nothing in Visual Basic) if no item is found. + + + + Gets the boundaries of the specified item. + + A zero-based integer value which specifies the item’s index. + A structure which represents the specified item’s boundaries. + + + + Gets the text string displayed by the item. + + An integer value representing the zero-based index of the item. + A string value representing the text displayed within the item. String.Empty if no item is found. + + + + Gets the specified item’s value. + + An integer value representing the zero-based index of the item whose value is returned. + An object representing the specifyed item’s value. null (Nothing in Visual Basic) if no item is found. + + + + Gets or sets the paint mode for the selected and hot-tracked items. + + A value that specifies the paint mode for the selected and hot-tracked items. + + + + Gets or sets whether a horizontal scroll bar is enabled when the control’s items are displayed in a single column and some of them exceed the control’s width. + + true if horizontal scrolling is enabled in single column display mode; otherwise, false. + + + + Gets or sets the offset by which the control is scrolled horizontally when the scrollbar buttons are clicked. This property is in effect in single column display mode, when the BaseListBoxControl.HorizontalScrollbar property is set to true. + + An integer value specifying the horizontal scrolling step in pixels. + + + + Gets the zero-based index of the currently hot-tracked item. + + The zero-based index of the currently hot-tracked item. + + + + Gets or sets whether list box items are hot-tracked when the mouse pointer moves over them. + + true if the items are hot-tracked; otherwise, false. + + + + Gets or sets how items are selected when item hot-tracking is enabled. + + A value that specifies how items are selected. + + + + Occurs when a user clicks an element within an HTML-CSS template. + + + + + Occurs when mouse pointer is over an element of an HTML-CSS template, and a mouse button is pressed. + + + + + Occurs when a mouse pointer moves while over an element of an HTML-CSS template. + + + + + Occurs when a mouse pointer leaves the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse pointer enters the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse button pressed over an element of an HTML-CSS template is released. + + + + + Gets or sets a collection of images that can be inserted into item captions using the image tag. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Stores HTML and CSS-based templates used to render listbox items. + + A collection of HTML and CSS-based templates used to render listbox items. + + + + Gets or sets whether incremental searching for items is enabled. + + true if incremental searching for items is enabled; otherwise, false. + + + + Returns the index of an item at specified coordinates. + + A structure containing the coordinates used to obtain the item index. + An integer value representing the zero-based index of an item at specified coordinates. -1 if no item is found. + + + + Gets a value indicating whether the list box control is being loaded. + + true if the list box control is being loaded; otherwise, false. + + + + Gets whether the current is locked by the BaseListBoxControl.BeginUpdate method. + + true if the is locked; otherwise, false. + + + + Gets or sets whether item height is automatically calculated to fit item contents. In auto-height mode, different items may have different heights. + + true if item height is automatically calculated; otherwise, false. + + + + Gets the number of elements contained in the collection of the list box control. + + An integer value representing the number of elements contained in the collection. + + + + Gets or sets an item’s height. + + An integer value representing an item’s height in pixels. + + + + Gets or sets padding within list items. + + A structure representing list item internal spacing characteristics. + + + + Gets or sets the horizontal scroll position. + + A zero-based integer value that specifies the horizontal scroll position. + + + + Makes the specified item visible on-screen if it is currently invisible. + + An integer value representing the item’s zero-based index. + + + + Provides the ability to change an individual item’s height. + + + + + Gets or sets whether listbox items can be arranged across multiple columns. + + true if the items can be arranged in multiple columns; otherwise, false. + + + + Fires when a related fires a query to the current List Box. Allows you to create a filter condition based on the query and specify how to highlight results in the control. + + + + + Selects all items when multiple item selection is enabled. + + + + + Gets or sets the index of the currently selected item. + + An integer value representing the zero-based index of the item in the list box control. -1 if no item is selected. + + + + Allows you to respond to item selection. + + + + + Gets a collection containing the indexes of all currently selected items in the list box control. + + A SelectedIndexCollection object representing the collection of all currently selected items in the control. + + + + Gets or sets the currently selected item. + + An object representing the list box control’s currently selected item. + + + + Gets currently selected items. + + A SelectedItemCollection object containing currently selected items. + + + + Gets or sets the currently selected item’s value. + + An object representing the currently selected item’s value. null (Nothing in Visual Basic) if no item is selected. + + + + Occurs after a value of the selected item has been changed. + + + + + Gets or sets whether a single or multiple items can be selected. + + A SelectionMode enumeration member specifying the list box control’s selection behavior. + + + + Assigns a new value to the specified item. + + An object representing a new value to be assigned to the specified item. + An integer value representing the zero-based index of the item to which a new value is assigned. + + + + Sets the specified item’s selection state. + + The zero-based index of the item whose selection state will be changed. + true to select the item; false to unselect the item. + + + + Gets or sets whether hovering over items selects the item being hovered over (modifies the control’s BaseListBoxControl.SelectedIndex property). + + true if item being hovered over is automatically selected; otherwise, false. + + + + Gets or sets whether the dotted focus rectangle is displayed around the focused item. + + true if the dotted focus rectangle is displayed around the focused item; otherwise, false. + + + + Gets or sets whether tooltips are displayed for items whose text is trimmed. + + A value that specifies whether tooltips are displayed for items whose text is trimmed. + + + + Raises the CustomSort event. + + + + + Gets or sets the sort order. + + A SortOrder enumeration member that specifies the sort order. + + + + Stores regular item templates used to render listbox items. + + The item template collection. + + + + This property is not supported by the class. + + A string value. + + + + Gets or sets the index of the first visible item in the list box control. + + An integer value specifying the zero-based index of the top visible item. + + + + Unselects all items when multiple item selection is enabled. + + + + + Gets or sets whether the control is painted grayed out when it’s in the disabled state. + + true if the control is painted grayed out, when it’s in the disabled state; otherwise, false. + + + + Gets or sets the field name in the bound data source whose contents are assigned to item values. + + A string value specifying a field name in the data source. + + + + Occurs after the BaseListBoxControl.ValueMember property value has been changed. + + + + + Serves as the base for editors with spin buttons used to modify edit values. + + + + + Creates a new object. + + + + + Closes the pop-up associated with the current -derived control without saving the current value. + + + + + Occurs when the -derived control’s pop-up was successfully closed. + + + + + Saves the current value and closes the pop-up associated with the -derived control. + + + + + Occurs when the -derived control’s pop-up is about to close. + + + + + Gets the editor’s class name. + + A System.String object identifying the editor’s class name. + + + + Occurs each time a control’s pop-up was displayed. + + + + + Gets an object containing properties and methods specific to the spin editor. + + A object instance containing settings specific to the spin editor. + + + + Occurs when the control’s pop-up window is to be closed. + + + + + Occurs each time a control’s pop-up is to be displayed. + + + + + This method is not supported for -derived controls. + + + + + Attempts to display the control’s pop-up window. + + + + + Serves as the base for controls that cannot be used as in-place editors and supports a common style management mechanism. + + + + + Initializes an instance of the class. + + + + + Gets the appearance settings used to paint the control’s contents. + + A object which provides the appearance settings used to paint the control’s contents. + + + + Gets or sets the background color of the control’s client region. + + A structure specifying the background color of the control’s client region. + + + + This event is not supported by the class. + + + + + Gets or sets the font used to display the control’s content. + + A object specifying the font used to display the control’s content. + + + + This event is not supported by the class. + + + + + Gets or sets the control’s foreground color. + + A structure specifying the color used to display the control’s text. + + + + This event is not supported by the class. + + + + + Resets the BaseStyleControl.BackColor property back to its default value. + + + + + Resets the BaseStyleControl.ForeColor property to its default value. + + + + + Resets the painter associated with this to its default state. + + + + + Resets the View Info object associated with this . + + + + + The base class for editors that work with binary large object (BLOB) data. + + + + + Creates a new instance of the PopupBaseEdit class. + + + + + Gets the current editor’s class name. + + A object identifying the class name of the current editor. + + + + Allows you to hide the default OK and Cancel buttons shown in the editor’s popup menus. + + + + + Gets an object containing settings specific to the BLOB editor. + + A object instance containing settings for the BLOB editor. + + + + The Microsoft Windows Explorer-inspired navigation bar that allows end users to navigate through a hierarchical tree of nodes. + + + + + Initializes a new instance of the class with the default settings. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns information on elements located at the target position. + + A Point structure that is the target location to be tested. + A DevExpress.XtraEditors.ViewInfo.BreadCrumbEditHitInfo object containing information on elements located at the target position. + + + + Returns information on elements located at the target position. + + An Int32 value that is the X-axis coordinate of the tested location. + An Int32 value that is the Y-axis coordinate of the tested location. + A DevExpress.XtraEditors.ViewInfo.BreadCrumbEditHitInfo object containing information on elements located at the target position. + + + + Tests whether or not calling the BreadCrumbEdit.GoBack method will have an effect. + + true if calling the BreadCrumbEdit.GoBack method will have an effect; otherwise, false. + + + + Tests whether or not calling the BreadCrumbEdit.GoForward method will have an effect. + + true if calling the BreadCrumbEdit.GoForward method will have an effect; otherwise, false. + + + + Tests whether or not calling the BreadCrumbEdit.GoUp method will have an effect. + + true if calling the BreadCrumbEdit.GoUp method will have an effect; otherwise, false. + + + + Returns whether this can store navigation history. To access this journal, use the RepositoryItemBreadCrumbEdit.History property (does not store records for navigation performed by mouse, touch gestures, or in code) or call the BreadCrumbEdit.GetNavigationHistory method (a complete history). + + true if this can store navigation history; otherwise, false. + + + + Returns the editor type name. + + Returns the “BreadCrumbEdit” string value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. Please use the BreadCrumbEdit.Path property instead. + + + + + Gets the object that stores the complete navigation history for this Breadcrumb Edit Control. + + A object that stores the complete navigation history for this control. + + + + Gets the current node path’s index within a navigation journal, retrieved by the BreadCrumbEdit.GetNavigationHistory method. + + An Int32 value that is the current node path’s index within a complete navigation journal. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.BreadCrumbPopupForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Navigates back to the previous entry in the navigation journal. + + + + + Navigates to next navigation journal entry. + + + + + Navigates to the currently selected node’s parent node. + + + + + Gets whether this currently has an expanded node. + + true if this currently has an expanded node; otherwise, false. + + + + Gets or sets the current nodes path within this , starting from a root to the last node visible. + + A String value that is the textual representation of the current nodes path. + + + + Occurs each time the current path changes. + + + + + Provides access to the main settings. + + A object that stores settings that specify the look and behavior. + + + + Clears the navigation journal, retrieved by the BreadCrumbEdit.GetNavigationHistory method. + + + + + Selects the entire path when this is in Edit mode. + + + + + Gets or sets the last item currently selected in this . + + A object that is the last item currently selected in this . + + + + Fires when this ‘s BreadCrumbEdit.SelectedNode changes. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Sets the current node path’s index within a navigation journal, retrieved by the BreadCrumbEdit.GetNavigationHistory method. + + An Int32 value that is the current node path’s index within a complete navigation journal. + + + + Invokes the pop-up menu that shows recently visited nodes. See the following help article for more information: History. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Stores the navigation history and allows you to navigate through these records. + + + + + Initializes a new instance of the class with the specified settings. + + A object that specifies the newly created ‘s settings. + + + + Adds the target to this collection. + + The to be added. + + + + Adds multiple s to this collection. + + s to be added. + + + + Adds multiple history items to this collection. + + An IEnumerable containing history items to be added to this collection. + + + + Occurs each time the is modified. + + + + + Determines whether this collection contains the target . + + A to be checked. + true if this collection contains the target ; otherwise, false. + + + + Releases all resources used by the current object. + + + + + Searches this collection for a , related to the target path. + + A String value that is the path to be checked. + A whose BreadCrumbHistoryItem.Path property value equals the path parameter. + + + + Gets the position within this collection. + + A BreadCrumbHistoryItem whose index is to be obtained. + An Int32 value that is the target ‘s index within this collection. + + + + Adds the to this collection and places it at a specific position within this collection. + + An Int32 value that specifies the newly added item’s index within this collection. + A to be added. + + + + Gets whether this collection is currently empty. + + true if this collection is currently empty; otherwise, false. + + + + Gets a that occupies a specific position within this collection. + + An Int32 value that is the index of a within this collection. + A that occupies a specific position within this collection. + + + + Moves a containing the specific path to the end of this collection. + + A Sting value that specifies the node path. A node whose BreadCrumbNode.Path value equals this parameter value will be re-arranged. + + + + Provides access the a object, assigned to this collection. + + A object, assigned to this collection. + + + + Removes the specific item from this collection. + + A to be removed. + + + + An object that stores the previously viewed path. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the BreadCrumbHistoryItem.Path property value for the newly created . + + + + Duplicates the target . + + A object that is the target object’s clone. + + + + Compares this with a specific object. + + An Object to be compared with this . + true if the compared object is a with the same BreadCrumbHistoryItem.Path property value as this ; otherwise, false. + + + + Gets the integer hash code that corresponds to the current object’s value. + + An Int32 value that is the ‘s hash code. + + + + Gets this ‘s position within its parent collection. + + An Int32 value that is the position within its parent collection. + + + + Moves the to the top of its parent collection. + + + + + Gets or sets the path within a control to which this relates. + + A String value that is the path within a control to which this relates. + + + + Gets the textual representation of this . + + A String value that represents this object’s BreadCrumbHistoryItem.Path property value. + + + + Exposes members used to label corresponding modes. + + + + + The ‘s path is represented as plain editable text. End users can use a keyboard to modify this path and navigate within the . + + + + + The ‘s path is represented as a sequence of click-able visual elements. Each element represents a and has a drop-down button that displays a drop-down list with all child nodes owned by this node. + + + + + A node within a control. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the newly created node’s caption. + A String value that is the newly created node’s value. + true if this node should raise the RepositoryItemBreadCrumbEdit.QueryChildNodes event when an end-user clicks its drop-down button; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the newly created node’s caption. + A String value that is the newly created node’s value. + + + + Initializes a new instance of the class with the specified settings. + + A String value that is the newly created ‘s caption. + + + + Locks the object and prevents any visual updates until the EndUpdate method is called. + + + + + Unlocks the node that was previously locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Gets or sets this ‘s caption. + + A String value that is this ‘s caption. + + + + Gets the child nodes collection for this . + + A BreadCrumbNodeCollection that contains child for this . + + + + Copies this . + + A that is the target ‘s clone. + + + + Copies this with or without its child nodes. + + true if the newly created should contain same nodes in its BreadCrumbNode.ChildNodes collection as the source ; otherwise, false. + A that is this ‘s clone. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Unlocks the node that was previously locked by the BeginUpdate method and causes an immediate visual update. + + + + + Gets whether this equals the target object. + + An Object to compare with this . + true if this equals the target object; otherwise, false. + + + + Returns a that is the child of this and is located at the specific path. + + A String value that specifies the path to the target child node, starting from this object. + A String value that specifies the path to the target child node, starting from the root node. + A that is this object’s child, located at a specific path. + + + + Gets the integer hash code that corresponds to the current object’s value. + + An Int32 value that is this ‘s hash code. + + + + Gets the image currently displayed as this ‘s glyph. + + An Image currently displayed as this ‘s glyph. + + + + Gets the current value. + + A String value that is the current value. + + + + Gets or sets the image. + + An Image that is the glyph. + + + + Gets or sets the index of an image from the RepositoryItemBreadCrumbEdit.Images collection that should be used as this ImageIndex glyph. + + An Int32 value that is the index of an image from the RepositoryItemBreadCrumbEdit.Images collection that should be used as this ImageIndex glyph. + + + + Gets this ‘s position within its parent node collection. + + An Int32 value that is this ‘s position within its parent node collection. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether this object is a parent node for the target object. + + A object to be checked. + true if this object is a parent node for the target object; otherwise, false. + + + + Gets whether this node is a top-level node. + + true if this node is a top-level node; otherwise, false. + + + + Gets the that follows this in its parent node collection. + + A that follows this in its parent node collection. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets this ‘s parent . + + A that contains this in its BreadCrumbNode.ChildNodes collection. + + + + Gets this ‘s path. + + A String value that is this ‘s path. + + + + Gets or sets whether this is constantly visible at runtime. + + true if this is constantly visible at runtime; otherwise, false. + + + + Gets or sets whether this can raise the RepositoryItemBreadCrumbEdit.QueryChildNodes event. + + true if this can raise the RepositoryItemBreadCrumbEdit.QueryChildNodes event; otherwise, false. + + + + Gets a that precedes this in its node collection. + + A that precedes this in its node collection. + + + + Provides access to the main settings. + + A RepositoryItemBreadCrumbEdit object that stores the main settings. + + + + Applies properties stored within the target to this . + + A whose property values should be copied to this . + + + + Gets or sets whether this ‘s caption is visible. + + true if this ‘s caption is visible; otherwise, false. + + + + Gets or sets the tag associated with this . + + An Object associated with this . + + + + Gets the textual representation of this . + + A String value that is this ‘s textual representation. + + + + Gets or sets this ‘s value. + + A String value that is the ‘s value. + + + + A collection. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A that will own the newly created . + + + + Initializes a new instance of the class with the specified settings. + + A RepositoryItemBreadCrumbEdit object related with the newly created . + + + + Adds the specific node to this . + + A to be added to this . + + + + Adds multiple nodes to this . + + s to be added to this . + + + + Adds multiple nodes to this . + + An IEnumerable that stores objects to be added to this . + + + + Locks the by preventing visual updates of the collection and its elements until the BreadCrumbNodeCollection.EndUpdate method is called. + + + + + Occurs each time a was added or removed to (from) the . + + + + + Gets whether the target is contained within this or any of its items’ BreadCrumbNode.ChildNodes collections. + + A to search for. + true if the search should be extended to the items’ child collections; otherwise, false. + true if the target was found; otherwise, false. + + + + Gets whether this contains the target node. + + A to be checked. + true if this contains the target node; otherwise, false. + + + + Unlocks the that was previously locked by the BreadCrumbNodeCollection.BeginUpdate method. + + + + + Unlocks the that was previously locked by the BreadCrumbNodeCollection.BeginUpdate method and specifies whether the BreadCrumbNodeCollection.CollectionChanged event should be fired. + + true if the BreadCrumbNodeCollection.CollectionChanged event should be fired; otherwise, false. + + + + Returns the with a specific value, if such a node exists within this , or within any BreadCrumbNode.ChildNodes collection of collection’s items. + + A String value that is the searched node’s BreadCrumbNode.Value property value. + true if the method should check not only items, but their BreadCrumbNode.ChildNodes collections as well; otherwise, false. + A BreadCrumbNode with the specific value. + + + + Gets the first node contained within this . + + A that is the first node in this . + + + + Returns the index within this . + + A whose position within this is to be obtained. + An Int32 value that is the index within this . + + + + Gets whether this contains a at the specific position. + + An Int32 value that is a node position to be checked. + true if this contains a at the specific position; otherwise, false. + + + + Adds a target to this and puts it to a specific position. + + An Int32 value that specifies the position within this where the target node should be arranged. + A object to be added to this . + + + + Gets or sets whether this is currently empty. + + true if this is currently empty; otherwise, false. + + + + Gets a node from this that has the specific index within this collection. + + An Int32 value that is the node index. + A that occupies the specific position within this . + + + + Gets the last node within this . + + A that is the last node within this . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Removes the specific node from this . + + A object to be removed from this . + + + + Removes all nodes from this starting from the specific position. + + An Int32 value that specifies the node index within this , starting from which all nodes should be removed from the collection. + + + + The text editor that displays buttons in the edit box. + + + + + Initializes a new ButtonEdit control instance. + + + + + Occurs when a button editor’s button is clicked. + + + + + Occurs when pressing an editor button. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Gets a value indicating whether a container needs to set focus to the editor when it works as an inplace control. + + true if a container needs to set focus to the editor; otherwise, false. + + + + For internal use. + + + + + Simulates the Click event for the specified button. + + An object to be clicked. + + + + Gets an object containing properties, methods and events specific to the control. + + A object containing settings for the control. + + + + Allows you to edit numeric values using a dropdown calculator. + + + + + Initializes a new class instance with default settings. + + + + + Validates the editor. + + A enumeration value that specifies how a dropdown editor’s popup window was closed. + true if the editor’s value is valid; otherwise, false. + + + + Gets the current editor’s class name. + + The string identifying the class name of the current editor. + + + + Gets or sets the editor’s value. + + An object representing the editor’s value. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupCalcEditForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets a object containing properties specific to the editor. + + The object containing properties specific to the calc editor. + + + + Gets or sets the text displayed in the edit box. + + The string displayed in the edit box. + + + + Gets or sets the editor’s decimal value. + + The editor’s decimal value. + + + + Occurs after the value of the CalcEdit.Value property has been changed. + + + + + Contains classes implementing the control’s drop-down calendar functionality. + + + + + Contains information about a specific point within a calendar control. + + + + + Initializes a new instance of the class for the specified point. + + A structure that defines a point in a plane. This value is assigned to the CalendarHitInfo.HitPoint property. + An ObjectState enumeration value that specifies the state of visual element under the hit point. This value is assigned to the CalendarHitInfo.HitInfoType property. + + + + Initializes a new instance of the class for the specified point. + + A structure that defines a point in a plane. + + + + Gets or sets the bounding rectangle of the visual element. Not applicable for the control. + + Empty System.Drawing.Rectangle structure. + + + + Gets the object which contains the information used to render the visual element located under the test point. + + A DevExpress.XtraEditors.Calendar.CalendarObjectViewInfoBase class descendant providing view information on the visual element located under the test point. + + + + Gets the object which contains the information used to render the calendar cell located under the test point. + + A DevExpress.XtraEditors.Calendar.CalendarCellViewInfo class descendant providing view information on the calendar cell located under the test point. + + + + Sets the properties to default values which indicate that the hit information is undefined. + + + + + Returns whether the specified bounds contain the current test point. + + A structure that specifies the bounds. + A type of visual element to assign to the CalendarHitInfo.HitTest property if the specified bounds contain the current test point. + true if the specified bounds contain the current test point; otherwise, false. + + + + Gets the object which contains the information used to render the calendar footer. + + A DevExpress.XtraEditors.Controls.CalendarFooterViewInfoBase class descendant providing view information on the calendar footer. + + + + Gets the object which contains the information used to render the calendar header. + + A DevExpress.XtraEditors.Controls.CalendarHeaderViewInfoBase class descendant providing view information on the calendar header. + + + + Gets or sets the calendar date located under the test point. + + A structure that specifies the calendar date located under the test point. + + + + Gets or sets whether the visual element located under the test point is in Normal, Hot, Pressed, Disabled or Selected state. + + An DevExpress.Utils.Drawing.ObjectState enumeration value that specifies the state of visual element located under the test point. + + + + Gets or sets the object being hit. + + A DevExpress.XtraScheduler.Drawing.DateNavigatorDayNumberCellInfo object if the day or weeknumber cell of the DateNavigator control is hit; otherwise, null. + + + + Gets or sets the test point. + + A structure that specifies the coordinates of the test point relative to the control’s top left corner. + + + + Gets a value which identifies the type of the visual element located under the test point. + + A enumeration value that identifies the type of the visual element located under the test point. + + + + Gets or sets the type of information the contains. + + A enumeration member. + + + + Indicates whether the specified object is equal to the current object. + + A object to be compared with the current object. + true if the specified object equals the current object; otherwise, false. + + + + Gets or sets whether the test point is located in the calendar header. + + true if the test point is located in the calendar header; otherwise, false. + + + + Gets whether the test point is located in a calendar cell. + + true if the test point is located in a calendar cell; otherwise, false. + + + + Gets whether the test point is located in the calendar footer. + + true if the test point is located in the calendar footer; otherwise, false. + + + + Gets whether the test point is located in the calendar header. + + true if the test point is located in the calendar header; otherwise, false. + + + + Gets whether the test point is located in the calendar navigation button. + + true if the test point is located in the calendar footer; otherwise, false. + + + + Gets or sets whether the test point is located in the time portion area. + + true if the test point is located in the time portion area; otherwise, false. + + + + Gets the point being hit. + + A structure that is the point within the control with coordinates relative to the control’s top-left corner. + + + + Gets the object which contains the information used to render the clock area. + + A DevExpress.XtraEditors.Controls.CalendarAreaViewInfoBase class descendant providing view information on the clock area. + + + + Sets the specified cell as the object being hit. + + View information about the calendar cell being hit. + + + + Gets the object which contains the information used to render the calendar. + + A DevExpress.XtraEditors.Controls.CalendarViewInfoBase class descendant providing view information on the calendar. + + + + Lists values that identify a visual element of the Date Editor and Calendar control and its descendants. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + For internal use. + + + + + The type of the visual element is undefined. + + + + + Provides data for the DateEdit.DrawItem event. + + + + + Initializes a new instance of the class with the specified settings. + + Allows you to paint custom shapes on a cell surface. + A value to initialize the CustomDrawDayNumberCellEventArgs.ViewInfo property. + A value to initialize the CustomDrawDayNumberCellEventArgs.BackgroundElementInfo property. + + + + Gets or sets the skin element that is used to paint the background of the currently processed cell. + + A SkinElementInfo object that specifies the skin element that is used to paint the background of the currently processed cell. + + + + Gets the painted element’s bounding rectangle. + + A structure specifying the boundaries of the painted element. + + + + Gets the bounds of the cell’s content (text). + + The bounds of the cell’s content (text). + + + + Gets the painted cell’s value. + + A object representing the painted day number’s cell value. + + + + Gets whether the painted cell is disabled. + + true if the painted cell is disabled; otherwise, false. + + + + Gets whether the currently processed cell is under the mouse cursor. + + true if the processed day number cell is hovered over by the mouse cursor; otherwise, false. + + + + Gets whether the painted cell corresponds to Saturday or Sunday. + + true if the painted cell corresponds to Saturday or Sunday; otherwise, false. + + + + Gets whether the painted cell belongs to the previous or next month. + + true if the painted cells belongs to the previous or next month; otherwise, false. + + + + Gets whether the cell is currently pressed. + + true if the cell is currently pressed; otherwise, false. + + + + Gets whether the cell corresponds to a “special” date. + + true if the cell corresponds to a “special” date; otherwise, false. + + + + Gets a value indicating whether the processed day number cell is selected. + + true if the processed cell is selected; otherwise, false. + + + + Gets the current cell’s state. + + The Normal, Hot, Pressed, Disabled or Selected state, or a combination of these states. + + + + Gets the painted date cell’s appearance settings. + + A object that provides the painted cell’s appearance settings. + + + + Gets whether the painted cell corresponds to Today’s date. + + true if the cell corresponds to Today’s date; otherwise, false. + + + + Gets or sets the current View of data in the dropdown window. + + A DateEditCalendarViewType value that specifies the current View of data in the dropdown window. + + + + Contains information used for painting the current cell. + + An object that contains information used for painting the current cell. + + + + Represents a method that will handle the RepositoryItemDateEdit.DrawItem event. + + The event sender. + A object that contains data related to the event. + + + + Provides types that support processing a video stream received from a video capture device. + + + + + Displays a video stream captured from a video input device, such as a webcam. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the control, when displayed for the first time, automatically starts showing the video stream from the default device. + + true if the control, when displayed for the first time, automatically starts showing the video stream from the default device; otherwise, false. + + + + Fires when a context button is clicked. + + + + + Allows you to customize the context buttons. + + + + + Provides access to the settings applied to the context buttons displayed in the control, and the panels containing these buttons. + + A ContextItemCollectionOptions object that comprises settings applied to the context buttons displayed in the control, and the panels containing these buttons. + + + + Provides access to the collection of context buttons displayed in the control. + + A ContextItemCollection object that represents the collection of context buttons displayed in the control. + + + + Occurs before the ‘s frame is drawn. Subscribe to customize the video stream’s frame. + + + + + Gets or sets the video capture device currently used by the control. + + A object that describes the video capture device currently used by the control. + + + + Occurs when the camera device used by the control is changed. + + + + + Gets or sets the notification displayed by the control if no capture device is found. + + A String value that specifies the notification displayed by the control if no capture device is found. + + + + Fires when the orientation is about to be changed due to display rotation, allowing you to override the rotate angle. + + + + + Returns the video capture device used by default. + + A object that the control uses by default. + + + + Returns the new object created based on the specified information. This is a static method. + + A object. + A object. + + + + Returns the list of the objects containing information about the available video capture devices. This is a static method. + + A list of the objects containing information about the available video capture devices. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Loads the video settings stored in the system registry by the specified path. + + A value that specifies the registry path from which to restore the video settings. + + + + Loads the video settings stored in the system registry by the specified stream. + + A Stream descendant from which the video settings are loaded. + + + + Loads the video settings stored in the specified XML file. + + A value that specifies the file from which to restore the video settings. + + + + Gets or sets the rotation angle of the control’s output. + + A value that specifies the rotation angle of the control’s output. + + + + Saves the video settings of the currently used capture device to the system registry. + + A value specifying the system registry path to which the video settings are saved. + true if the operation is successfully completed; otherwise, false. + + + + Saves the video settings of the currently used capture device to the specified stream. + + A Stream descendant to which the video settings are written. + + + + Saves the video settings of the currently used capture device to the specified file in XML format. + + A value that specifies the name of file to save the video settings. + + + + Gets or sets whether the context button that invokes the Camera Settings form is displayed in the top far corner of the control. + + true if the context button that invokes the Camera Settings form is displayed; otherwise, false. + + + + Invokes the form that contains the camera device settings. + + + + + Starts showing the video stream from the currently used device. + + + + + Starts showing the video stream from the specified device. + + A object from which to capture and show the video stream. + + + + Stops showing the video stream from the currently used device. + + + + + Returns the video frame currently captured by the device being used. + + A object that is the video frame currently captured by the device being used. + + + + Gets or sets whether the uses the DirectX Hardware Acceleration. + + A DefaultBoolean enum value that specifies whether this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + Provides access to the video settings (brightness, contrast, etc.) on the currently used device. + + A object that comprises the video settings (brightness, contrast, etc.) on the currently used device. + + + + Gets or sets how the video frame fits the control. + + A enumeration value that specifies how the video frame fits the control. + + + + Describes a video capture device, operates the device, and processes the received video stream. + + + + + Initializes a new instance of the class with the specified settings. + + A object that comprises system information about a video capture device. + + + + Gets the frame currently captured by the device. + + A Bitmap object that is the frame currently captured by the device. + + + + For internal use. + + + + + Enumerates camera resolution modes. + + + + + The default resolution of the selected camera device. + + + + + The most recently used resolution. + + + + + The resolution is specified by the ManualResolution property (TakePictureDialogShowingEventArgs.ManualResolution and TakePictureDialog.ManualResolution). + + + + + The maximum resolution supported by the camera device. + + + + + The modal dialog to take pictures from a camera device. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the dialog’s caption. + + The dialog’s caption. + + + + Fires when the dialog is closed. Allows you to get the dialog result and captured image, and replace this image. + + + + + Gets or sets the camera device. + + The camera device. + + + + Gets the snapshot that a user has captured using the camera device. + + The captured image. + + + + Gets or sets a camera resolution that is applied when the TakePictureDialog.ResolutionMode property is set to Manual. + + A custom camera resolution. + + + + Gets or sets the camera resolution mode. + + The camera resolution mode. + + + + Displays the Take Picture dialog. + + The dialog’s result + + + + Displays the Take Picture dialog with the specified caption. + + The dialog’s caption. + The dialog’s result. + + + + Fires when the dialog is about to be displayed. Allows you to customize the form, and specify the camera device and resolution. + + + + + Provides data for the PictureEdit.TakePictureDialogShowing, RepositoryItemPictureEdit.TakePictureDialogShowing and TakePictureDialog.Showing events. + + + + + Initializes a new instance of the class with specified settings. + + The form that encapsulates the dialog. + + + + Gets or sets the camera device. + + The camera device. + + + + Gets the form that encapsulates the dialog. + + The form that encapsulates the dialog. + + + + Gets or sets a camera resolution that is applied when the TakePictureDialogShowingEventArgs.ResolutionMode property is set to Manual. + + A custom camera resolution. + + + + Gets or sets the camera resolution mode. + + The camera resolution mode. + + + + Provides members that specify how the video frame is stretched to fit the . + + + + + The default mode. This value is equivalent to the ZoomInside value. + + + + + The video frame is not stretched. + + + + + The video frame is stretched to fill the available client area. + + + + + Zooms the video frame proportionally, so that it is displayed in the client area in its entirety. + + + + + Zooms the video frame proportionally, making its smaller side (width or height) displayed in its entirety. The frame is centered, so the larger side (height or width) is not displayed in its entirety. + + + + + The base class for all chart clients of the range control. + + + + + Initializes a new instance of the class with the specified sparkline scale type, grid options, and range. + + A SparklineScaleType representing the scale type (date-time or numeric) of the sparkline. + A object that contains properties to customize the grid of the chart range control client. + A object representing the range of the chart range control client. + + + + Occurs before a series of the chart range control client is drawn in the range control’s viewport. + + + + + Gets a data provider to bind a chart range control client to regular data sources. + + A object that is a data provider for a chart range control client. + + + + Provides access to the grid options of the chart range control client. + + A object containing grid options for the chart client of the range control. + + + + Gets or sets the name of the palette currently used to draw the chart range control client’s elements. + + A value which is the palette name. + + + + Gets the collection of predefined palettes. + + A collection of objects. + + + + Provides access to the auto range option of the chart range control client. + + A object that contains the auto range option of the chart range control client. + + + + Gets or sets the associated with the current . + + A System.ComponentModel.ISite object associated with the current . + + + + The class that is used to supply data to a chart range control client. + + + + + Gets or sets the name of the data field that contains the arguments of the chart range control client’s points. + + A value that specifies the data field name. + + + + Gets or sets the chart range control client provider’s data source. + + An object that represents the data source from which the chart range control client retrieves its data. + + + + Disposes of the current object and releases all the allocated resources. + + + + + Reloads data from the underlying data source and repaints the viewport area of the range control. + + + + + Gets or sets the name of the data field whose values are used to automatically generate and populate the series of a chart range control client. + + A value that specifies the data field’s name. + + + + Specifies a chart client template view type for the range control. + + A object descendant that is the chart client view type. + + + + Returns the textual representation of the current object. + + A string that specifies the textual representation of the current object. + + + + Gets or sets the name of the data field that contains the point values of a chart range control client. + + A value that specifies the data field name. + + + + The base class for grid settings of the date-time and numeric chart clients of the range control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a value that specifies whether the grid properties are calculated automatically. + + true if the grid is calculated automatically; otherwise, false. + + + + Gets or sets a value that specifies the interval between grid lines. + + A value which specifies the numeric grid step. + + + + Gets or sets the string used to format chart argument values. + + A string used to format chart argument values. + + + + Gets or set the format provider to format the values displayed by argument labels of the chart range control client. + + A object that supplies specific formatting information to the values displayed by argument labels. + + + + Gets or sets a value which specifies whether to show the grid lines error message in the range control’s viewport. + + true, to show the grid lines error message in the range control’s viewport; otherwise,false. + + + + Gets or sets the numeric snap step. + + A value that is the snap step. + + + + Returns the textual representation of the current object. + + A string that specifies the textual representation of the current object. + + + + The base class for defining the range for all chart clients (date-time and numeric chart clients) of the range control. + + + + + Gets or sets a value that specifies whether the range of the chart range control client is calculated automatically. + + true if the chart client range is calculated automatically; otherwise, false. + + + + Returns the textual representation of the current object. + + A string that specifies the textual representation of the current object. + + + + The base class for all chart views of the chart range control client. + + + + + Initializes a new instance of the class with a sparkline view type. + + A object representing a sparkline view type. + + + + Gets or sets a color that fills the view of the chart range control client. + + A value. + + + + Returns the textual representation of the current object. + + A string that specifies the textual representation of the current object. + + + + A button that supports two states - elevated and depressed. It is possible to prevent the button from receiving focus on click. Multiple buttons can be combined into a radio group, in which only one button is checked at a time. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified check state. + + A Boolean value that specifies the button’s check state. This value is assigned to the CheckButton.Checked property. + + + + Gets or sets whether a checked button that belongs to a logical group can be unchecked by clicking this button. + + true if a checked button that belongs to a logical group can be unchecked by clicking this button. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An Action that specifies whether this is currently enabled. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An Action that uses the boolean function to specify whether or not this is currently checked. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An Action that specifies whether this is currently checked. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets the button’s check state. + + true if the button is checked (in the depressed state); false if the button is unchecked (in the elevated state). + + + + Allows you to respond to the button’s check state being changed. + + + + + Gets or sets the button’s group index. Within a group, only one button may be checked at a time. When users click another button in a group, the checked state moves from the current button to the clicked one. + + The button’s group index + + + + Swaps the button’s check state. + + + + + An editor that displays a list of check boxes in a drop-down menu. Users can select multiple items. + + + + + Initializes a new instance of the class. + + + + + Checks all the control’s items. + + + + + Enables you to sort items in custom order. + + + + + Validates the editor. + + A enumeration value that specifies how a dropdown editor’s popup window was closed. + true if the editor’s value is valid; otherwise, false. + + + + Occurs whenever this has to display a child list box item. Allows you to manually paint these items. + + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + Gets or sets an object that specifies the values of the items selected in the drop-down list. Depending on the option, this property returns a object that contains these values, or a object that contains the string representations of these values, separated by a comma (or a custom separator) and a space character. + + An object that specifies the editor’s value. + + + + Returns the index of the first item that matches the custom criteria implemented in the predicate delegate method. + + An Int32 value that is a item index, starting from which the method should seek the matching item. + true, to search from the collection’s beginning to its end; otherwise, false. + A delegate that implements the search criteria. + An Int32 value that is the index of the found item within the RepositoryItemCheckedComboBoxEdit.Items collection. If no items were found, returns -1. + + + + Searches for the first item that starts with the target text. The search is performed in the specific direction and starts from the required item. + + A String value that is the text to find. + An Int32 value that is a item index, starting from which the method should seek the matching item. + true to search from the collection’s beginning to its end; otherwise, false. + An Int32 value that is the found item’s index within this . If no item was found, returns -1. + + + + Searches for the first item that starts with the target text. The search starts from the required item. + + A String value that is the text to find. + An Int32 value that is a item index, starting from which the method should seek the matching item. + An Int32 value that is the found item’s index within this . If no item was found, returns -1. + + + + Searches for the first item that starts with the target text. + + A String value that is the text to find. + An Int32 value that is the found item’s index within this . If no item was found, returns -1. + + + + Searches for a item whose caption is equal to the target string. The search is performed starting from the desired item. + + A String value that is the text to find. + An Int32 value that is a item’s index, starting from which the method should seek the matching item. + An Int32 value that is the found item’s index within this . If no item was found, returns -1. + + + + Searches for a item whose caption is equal to the target string. + + A String value that is the text to find. + An Int32 value that is the found item’s index within this . If no item was found, returns -1. + + + + Enables you to disable specific items. + + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.CheckedPopupContainerForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Returns a that displays check items in the control’s dropdown. + + A CheckedListBoxControl embedded in the control’s dropdown. + + + + Checks if the item is the Select All item. + + The list box item that needs to be checked. + True if the item is the Select All item, otherwise false. + + + + Fires after an item’s check state was changed. + + + + + Fires before an item’s check state changes and allows you to cancel the action. + + + + + Provides the capability to change the height of an individual item. + + + + + Gets an object which contains properties, methods and events specific to the control. + + A object that contains a control’s settings. + + + + This event is not supported by the class. + + + + + This event is not supported by the class. + + + + + Synchronizes the editor’s edit value with check items in the dropdown, checking and unchecking corresponding items. + + + + + Assigns the value to the CheckedComboBoxEdit.EditValue property, and checks editor items that have related values. + + An object that identifies checked items in the editor’s dropdown window. + + + + Raises the CustomSort event. + + + + + Allows an end user to select among the unchecked, checked, and indeterminate state (optional). Multiple check boxes can be combined into a radio group. + + + + + Initializes a new control instance with default settings. + + + + + Gets or sets whether the check editor is in the checked state. + + true if the editor is checked; otherwise, false. + + + + Fires after the CheckEdit.Checked property value has been changed. + + + + + Gets or sets the editor’s check state. + + The check editor’s state. + + + + Fires after the CheckEdit.CheckState property value has been changed. + + + + + Allows you to choose the order in which this CheckEdit cycles through its “Checked”, “Unchecked”, and “Indeterminate” states. The “Indeterminate” state is available if the RepositoryItemCheckEdit.AllowGrayed property is enabled. + + Specifies the state order. + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + Gets or sets the editor’s edit value. + + The editor’s edit value. + + + + Gets an object containing properties, methods and events specific to a check editor. + + A object instance containing settings for the control. + + + + Allows for custom conversion from the edit value to a check state (checked, unchecked and indeterminate). + + + + + Allows for custom conversion from a check state (checked, unchecked and indeterminate) to an edit value. + + + + + Values of this enumeration specify the order in which a CheckEdit cycles through its “Checked”, “Unchecked”, and “Indeterminate” states. + + + + + CheckEdit editors cycle through their states in the “Indeterminate - Checked - Unchecked” order. + + + + + CheckEdit editors cycle through their states in the same order as for the Unchecked value (“Indeterminate - Unchecked - Checked”). + + + + + CheckEdit editors cycle through their states in the “Indeterminate - Unchecked - Checked” order. + + + + + Changes the state of a check editor. + + + + + The checked list box control, in which each item can be checked, unchecked or set to the grayed state. The control can be populated with items from a data source. + + + + + Creates a new object with default settings. + + + + + Gets or sets whether single or multiple items can be checked simultaneously. + + A DevExpress.XtraEditors.CheckMode enumeration value, such as Single or Multiple, that specifies whether single or multiple items can be checked simultaneously. + + + + Provides data for the ChartRangeControlClientBase.CustomizeSeries event. + + + + + Gets the value from a datasource assigned to the ChartRangeControlClientDataProvider.DataSource property of the chart range control client (numeric or date-time). + + An object representing the value contained in the specified datasource. Null if the value is not found in the datasource. + + + + Gets or sets the view type for the chart range control client. + + A object descendant that is the chart client view type. + + + + Allows you to customize options provided by the “Select Color” dialog. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the dialog’s UI allows users to select a transparent color (set the transparency level). + + true if the dialog’s UI allows users to set the color transparency level; otherwise, false. + + + + Copies settings from the object passed as the parameter. + + A object whose settings are copied to the current object. + + + + Disposes of the object. + + + + + Gets or sets the icon applied to the “Select Color” dialog. + + An Icon object displayed in the “Select Color” dialog. + + + + Provides access to the object’s settings that allow you to assign raster and vector images (instead of traditional .ico images) to the editor’s “More Colors…” dialog. + + Provides access to the current color dialog’s icon options. + + + + Resets all settings to their default values. + + + + + Gets or sets whether the “Select Color” dialog contains titled arrows along the sides of color boxes. + + A ShowArrows value that specifies whether the “Select Color” dialog contains titled arrows along the sides of color boxes. + + + + Gets or sets whether the “Select Color” dialog contains the “Make Web-Safe” button. + + true if the “Select Color” dialog contains the “Make Web-Safe” button; otherwise, false. + + + + Gets or sets whether the dialog contains a preview box. + + true if the “Select Color” dialog contains a preview box; otherwise, false. + + + + Gets or sets whether the RGB, HSB or both tabs (color models) are available. + + A ShowTabs value that specifies which tabs are displayed within the “Select Color” dialog. + + + + The editor that allows you to select a color from a dropdown window. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets the currently selected color. + + A structure representing the currently selected color. + + + + Occurs after the value of the ColorEdit.Color property has been changed. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Gets or sets the selected color. + + An object representing the currently selected color. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupColorEditForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets settings specific to the color editor. + + The object storing settings specific to the current editor. + + + + Gets the text displayed in the edit box. + + The text displayed in the edit box. + + + + An advanced drop-down color picker that supports multiple palettes (a predefined Web and System color palette) from which to choose colors. + + + + + Initializes a new instance of the class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A System.Windows.Forms.Control object representing the control containing the current editor. + A System.Drawing.Point object representing the coordinates of a mouse click. + true, a mouse click is allowed; otherwise, false. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.PopupColorPickEditForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets whether the “Automatic” color is selected by an end-user in the Custom tab in the dropdown window. + + true if the “Automatic” color is selected by an end-user in the Custom tab; otherwise, false. + + + + The base class for the control. + + + + + Initializes a new instance of the class. + + + + + Fires after the “Select Color” dialog has been closed. + + + + + Fires when the “Select Color” dialog is about to be displayed. + + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + Provides access to the editor’s settings. + + A object that holds the control’s settings. + + + + Allows you to customize tooltips displayed when hovering over colors in the Custom and Web-Safe palettes. + + + + + Contains data for the RepositoryItemColorPickEdit.TooltipShowing event. + + + + + Initializes a new instance of the class with the specified settings. + + A Color value used to initialize the ColorPickEditTooltipShowingEventArgs.Color property. + A string value used to initialize the ColorPickEditTooltipShowingEventArgs.TitleText property. + A string value used to initialize the ColorPickEditTooltipShowingEventArgs.ContentText property. + A value used to initialize the ColorPickEditTooltipShowingEventArgs.Format property. + + + + Gets the color for which a tooltip will be displayed. + + The Color value for which a tooltip will be displayed. + + + + Gets or sets the content for the current tooltip. + + A string that is the content for the current tooltip. + + + + Gets the display format of the current color’s value displayed in the tooltip. + + A value that is the display format of the current color’s value. + + + + Gets or sets the title for the current tooltip. + + A string that is the tooltip’s title. + + + + Contains values that specify how the values of colors are presented on-screen. + + + + + A color’s value is presented in the ARGB format. + + + + + A color’s value is presented in hexadecimal format. + + + + + A combo box editor that enables users to edit values by selecting items from a drop-down list. + + + + + Creates and initializes a new combo box editor. + + + + + A text editor that allows a user to select predefined items (typically, strings) from a drop-down list. The drop-down item list cannot be populated from a data source. Use lookup editors to display data source items in the drop-down list—, , , and . + + + + + Creates and initializes a new instance of the class. + + + + + Provides the ability to custom paint the items displayed within the combo box editor’s drop down. + + + + + Occurs when drawing a specific item in the dropdown list. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Allows you to select an item with the specific value, or to read the currently selected item’s value. You can also use the ComboBoxEdit.SelectedItem property to do the same. Additionally, EditValue allows you to specify a custom editor value. + + The edit value. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.ComboBoxPopupListBoxForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets settings specific to the combo box editor. + + A object containing settings for the current editor. + + + + Resets the selection and caret position in the editor. + + + + + Gets or sets the index of the selected ComboBox item. This index specifies the item position inside the RepositoryItemComboBox.Items collection. + + The zero-based index of the edit value in the RepositoryItemComboBox.Items collection; otherwise, -1. + + + + Occurs when the selection moves from one ComboBoxEditor item to another. + + + + + Specifies the editor’s value. + + The editor’s value. + + + + Occurs when changing the index of the selected value in the combo box editor. + + + + + Contains base classes for container controls and components provided by DevExpress. Such controls and components manage in-place editors and control the appearance and behavior of tooltips. + + + + + Serves as the base for components that provide visual elements at runtime, manage editor repositories providing inplace editors for their visual elements and support the common tooltip control mechanism. + + + + + Initializes a new class instance with default settings. + + + + + Notifies the component that the initialization has started. + + + + + Occurs when a key is pressed within an in-place editor that belongs to the container component. + + + + + Occurs when a character key is pressed within an in-place editor that belongs to the container component. + + + + + Occurs when a pressed key is released within an in-place editor that belongs to the container component. + + + + + Notifies the component that the initialization has been completed. + + + + + Gets or sets the external editors repository. + + A component holding a collection of repository items that can be used to create inplace editors. + + + + Returns the actual tooltip controller that controls the behavior and appearance of hints for a container component’s elements. + + A object providing tooltip functionality for the container component. + + + + Gets whether the component is being initialized. + + true if the component is being initialized; otherwise, false. + + + + Provides access to the component’s internal repository. + + A object containing repository items whose settings can be used to create inplace editors. + + + + Gets or sets the component that controls the behavior and appearance of hints displayed for the container component’s visual elements. + + A component specifying hint settings. + + + + Serves as the base for container controls that manage editor repositories providing inplace editors for their visual elements and support for a common tooltip control mechanism. + + + + + Initializes a new instance with default settings. + + + + + Gets or sets whether the allows touch gestures when the app runs on touch-enabled devices. + + A enumeration value that specifies whether the should process user gestures when the app runs on touch-enabled devices. + + + + Gets or sets the control’s background color. + + A structure that represents the control’s background color. + + + + Notifies the control that the initialization has started. + + + + + Returns whether the descendant is active. + + true if the descendant is active; otherwise, false. + + + + Occurs when a key is pressed within an in-place editor that belongs to the container control. + + + + + Occurs when a character key is pressed within an in-place editor that belongs to the container control. + + + + + Occurs when a pressed key is released within an in-place editor that belongs to the container control. + + + + + Notifies the control that the initialization has been completed. + + + + + Gets or sets the external repository of in-place editors. + + A component holding a collection of in-place editors (repository items). + + + + Gets or sets the control’s foreground color. + + A structure that represents the control’s foreground color. + + + + Returns the actual tooltip controller that controls the behavior and appearance of hints for the container editor. + + A object providing tooltip functionality for the container editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether the control is being initialized. + + true if the control is being initialized; otherwise, false. + + + + Gets or sets an object that controls the look and feel of the popup menus. + + An object that controls the look and feel of the popup menus. + + + + Provides access to the control’s internal repository of in-place editors. + + A object containing repository items whose settings are used to create in-place editors. + + + + For internal use. + + + + + + For internal use. + + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the control’s text. + + A string which specifies the control’s text. + + + + Gets or sets the component that controls the behavior and appearance of hints displayed for a container control’s visual elements. + + A component specifying hint settings. + + + + Provides a graphical interface for navigating data-aware controls that implement the INavigatableControl interface (this interface is implemented by all DevExpress data-aware container controls). + + + + + Creates a new object with default settings. + + + + + Provides access to the navigator’s built-in and custom buttons. + + A object which is the navigator’s buttons. + + + + Gets or sets the control which is navigated by the ControlNavigator. + + An object implementing the INavigatableControl interface which is navigated by the ControlNavigator. + + + + Returns the text representation of the current object. + + A string that specifies the text representation of the current object. + + + + The ControlNavigator‘s button collection. + + + + + Creates a new object. + + A object representing the buttons dispalyed within the ControlNavigator. + + + + A collection of buttons displayed in the ControlNavigator. + + + + + Creates a new object. + + An object implementing the INavigatorOwner interface to which the object belongs. This value is assigned to the NavigatorButtonsBase.Owner property. + + + + Gets the button used to append a new record. + + A object representing the navigator’s Append button. + + + + Gets the button used to cancel editing the current record. + + A object representing the navigator’s CancelEdit button. + + + + Gets the control which is bound to the ControlNavigator. + + An object implementing the INavigatableControl interface which is navigated by the ControlNavigator. + + + + Gets the button used to set the dataset to the edit state. + + A object representing the navigator’s Edit button. + + + + Gets the button used to post the edited record to the associated data source. + + A object representing the navigator’s EndEdit button. + + + + Gets the button used to set the current record to the first record in a data source. + + A object representing the navigator’s First button. + + + + Gets the button used to set the current record to the last record in a data source. + + A object representing the navigator’s Last button. + + + + Gets the button used to set the current record to the next record in a data source. + + A object representing the navigator’s Next button. + + + + Gets the button used to increment the current record position in a data source by the number of visible records. + + A object representing the navigator’s NextPage button. + + + + Gets the button used to set the current record as the data source’s previous record. + + A object representing the navigator’s Prev button. + + + + Gets the button used to decrement the current record position in a data source by the number of visible records. + + A object representing the navigator’s PrevPage button. + + + + Gets the button used to delete the current record. + + A object representing the navigator’s Remove button. + + + + Contains classes that provide editor functionality and specify editor appearance. + + + + + Provides data for the RepositoryItemMRUEdit.AddingMRUItem event. + + + + + Initializes a new instance of the class with the specified settings. + + An item being added to the editor. + A value that identifies the reason that caused the AddingMRUItem event. + + + + Creates a new class instance. + + A representing an item being added to an MRU editor. Initializes the Item property. + + + + Gets the reason that caused the AddingMRUItem event. + + A value. + + + + Represents a method that will handle the RepositoryItemMRUEdit.AddingMRUItem event. + + The event sender (typically an MRU edit control). + A object containing data related to the event. + + + + Provides data for events that allow you to validate cell values. + + + + + Creates a object. + + An object representing the validated editor’s value. This value is assigned to the BaseContainerValidateEditorEventArgs.Value property. + + + + Gets or sets the error description. + + A string value specifying the error description. + + + + Gets or sets whether the value is valid. + + true to indicate that the value is valid; otherwise false. + + + + Gets or sets the value being validated. + + An object representing the validated editor’s value. + + + + Represents the method for handling events which take a object as a parameter. + + The source of the event. + A object that contains event data. + + + + Contains values that specify “best-fit” modes for lookup editors. + + + + + The “best-fit” functionality is invoked when opening the dropdown window for the first time, changing the proportional widths of the columns to best fit their contents. + + + + + The “best-fit” functionality is invoked when opening the dropdown window for the first time, changing the proportional widths of the columns according to their contents and resizing the dropdown window to fit all the columns. + The dropdown window cannot be reduced to a size less than the minimum size specified by the editor’s RepositoryItemPopupBase.PopupFormMinSize property. + + + + + The “best-fit” functionality is not invoked. + + + + + Provides data for the RepositoryItemButtonEdit.ButtonPressed and RepositoryItemButtonEdit.ButtonClick events. + + + + + Creates and initializes a new object of the class. + + The object used to initialize the ButtonPressedEventArgs.Button property. + + + + Gets the button being pressed/clicked. + + The object specifying the currently pressed/clicked button. + + + + Represents a method for handling the RepositoryItemButtonEdit.ButtonPressed and RepositoryItemButtonEdit.ButtonClick events of a control. + + The event source. + A that contains event data. + + + + Displays a monthly calendar and allows an end-user to select a date or date range(s). + + + + + Initializes a new instance of the class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Imitates a click on the Today button. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when the Today button is clicked. + + + + + The base class for controls that incorporate calendars. + + + + + Initializes a new instance of the class. + + + + + Adds the specified date range to the selection. + + The range to be added to the selection. +The object specifies dates that lie in the range between the DateRange.StartDate (including this date) and the DateRange.EndDate (excluding this date). + + + + Adds the specified date range to the selection. + + The first date of a range (this date is included in the range) + The last date of a range (this date is NOT included in the range). + + + + Adds the specified date to the selection. + + The date to be added to the selection. + + + + Gets or sets whether animation effects are applied when switching between calendar views. + + true if calendar views are switched using animation effects; otherwise, false. + + + + Gets or sets whether a click on an inactive date (see CalendarControlBase.InactiveDaysVisibility) navigates to the corresponding (previous or next) month. + + true if a click on an inactive date navigates to the corresponding (previous or next) month; otherwise, false. + + + + This property is obsolete. Use the CalendarControlBase.CalendarAppearance property instead. + + + + + This property is obsolete. Use the CalendarControlBase.CalendarAppearance property instead. + + + + + This property is obsolete. Use the CalendarControlBase.CalendarAppearance property instead. + + + + + This property is obsolete. Use the CalendarControlBase.CalendarAppearance property instead. + + + + + Gets or sets whether the calendar automatically adjusts its size depending on the calendar display mode. + + true if auto-size mode is enabled; otherwise, false. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Gets or sets the style of buttons within this control. + + A enumeration value that specifies the style applied to this control’s buttons. + + + + Contains appearance settings used to paint the Calendar’s elements and date cells in various states. When a Skin is active, only day cell-related appearance settings are in effect. + + The calendar appearance settings. + + + + Gets or sets whether an end-user can select a date in the calendar. Disable this setting to allow end-users to enter only the time portions of date-time values (see CalendarControlBase.CalendarTimeEditing). + + true if an end-user can select a date in the calendar; otherwise, false. + + + + Gets or sets the horizontal indent between adjacent months, in pixels. + + The horizontal indent between adjacent months, in pixels. + + + + Gets or sets the vertical and horizontal indent between adjacent months, in pixels. + + The vertical and horizontal indent between adjacent months, in pixels + + + + Gets or sets whether an end-user can edit the time portion of a date value via the calendar. This functionality is supported in the CalendarView.Vista and CalendarView.Classic display modes. + + A value that specifies whether an end-user can edit the time portion of a date value via the calendar. + + + + Contains settings related to time editing within the calendar. + + Time editing settings. + + + + Gets or sets the vertical indent between adjacent months, in pixels. + + The vertical indent between adjacent months, in pixels. + + + + Gets or sets the calendar display mode. + + The calendar display mode. + + + + Returns whether or not this object’s popup can be closed at the moment. + + true if the popup can be closed; otherwise, false. + + + + Gets or sets the text case of month names. + + The text case of month names. + + + + Gets or sets the text case of days of the week abbreviations. + + The text case of days of the week abbreviations. + + + + Gets or sets the amount of space in pixels between a cell’s borders and its content (text). + + Calendar cell padding + + + + Gets or sets calendar cell size. + + The calendar cell size. + + + + Gets or sets the ICalendarCellStyleProvider object that allows you to customize the appearance of certain dates. + + The object that allows you to customize the appearance of certain dates. + + + + Gets or sets the number of months displayed horizontally. + + The number of months displayed horizontally. + + + + Allows you to respond to a context button click. + + + + + Allows you to customize context buttons in certain calendar cells. + + + + + Provides access to the settings applied to context buttons displayed in calendar cells. + + An object that contains settings applied to the context buttons. + + + + Provides access to the collection of context buttons displayed in each calendar cell. + + The collection of context buttons. + + + + Fires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Occurs when drawing each day cell in the calendar. + + + + + Allows you to provide custom week day abbreviations. + + + + + Allows week numbers to be customized. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the edit value (current date). This value is in sync with the CalendarControlBase.EditValue property. + + The edit value. + + + + Fires when the CalendarControlBase.DateTime property value changes. + + + + + Fires when the CalendarControlBase.DateTime property value changes as a result of actions performed by an end-user. + + + + + Allows you to disable certain dates to prevent them from being selected by an end-user. + + + + + Allows you to assign an ICalendarDisabledDateProvider object that can disable certain dates to prevent them from being selected by an end-user. + + An object that can disable certain dates to prevent them from being selected by an end-user. + + + + Gets or sets whether to draw lines between calendar cells. + + true if lines between calendar cells are visible; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the edit value (current date). + + The current date. + + + + Fires when the CalendarControlBase.EditValue property value changes. + + + + + Gets or sets the first day of the week. + + A enumeration value specifying the first day of the week. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Allows you to convert the EditValue to the DateTime format. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns the last date of the last month currently displayed in the calendar. + + A structure that specifies the last date of the last month currently displayed in the calendar. + + + + Obtains information on the calendar control’s element located at the specified point. + + A structure which specifies the test point coordinates relative to the calendar control’s top-left corner. + A object which comprises information about a specific point in the calendar control. + + + + Retrieves information on the calendar control element located at a specific point. + + An object that comprises the test point coordinates relative to the calendar control’s top-left corner. + A object which comprises information about a specific point in the calendar control. + + + + Returns the culture information used to display culture-specific data in the calendar. + + A CultureInfo used to display culture-specific data in the calendar. + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A value. + + + + Returns the first date of the first month currently displayed in the calendar. + + A structure that specifies the first date of the first month currently displayed in the calendar. + + + + Gets or sets the amount of space around the calendar header displaying the current month and year. This property is in effect for the Classic calendar view. + + A structure that specifies the amount of space around the calendar header displaying the current month and year. The default is Padding(2,5,2,5). + + + + Gets or sets whether Saturdays and Sundays are highlighted. You can customize the appearance of these days using the CalendarControlBase.CalendarAppearance property. + + true if Saturdays and Sundays are highlighted; otherwise, false. + + + + Gets or sets whether the selection is highlighted. + + true if the selection is highlighted; otherwise, false. + + + + Gets or sets whether Today’s date is highlighted. + + A value that specifies if Today’s date is highlighted + + + + Gets or sets how the cell that displays today date should be painted upon selection. You may choose between the ‘Today cell’ and ‘selected cell’ highlight styles. + + true, to apply the ‘today cell’ appearance; otherwise, false. + + + + Gets the hot-tracked date. + + The date that is hovered over. + + + + Gets or sets the visibility of dates that do not belong to the current month. + + The visibility of dates that do not belong to the current month. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Get or sets whether the control is being drawn. For internal use. + + true if the control is being drawn; otherwise, false. + + + + Gets or sets the maximum date displayed by the calendar. + + The maximum date displayed by the calendar. + + + + Gets or sets the minimum date displayed by the calendar. + + The minimum date displayed by the calendar. + + + + Gets or sets the padding around month names when several months are displayed simultaneously. + + A structure that specifies the padding around month names when several months are displayed simultaneously. + + + + This property is obsolete. Use the CalendarControlBase.SelectionMode property instead. + + + + + Gets or sets the date assigned to the CalendarControlBase.DateTime property when the Clear button is clicked, or when the CalendarControlBase.EditValue property is set to null or any value that cannot be converted to the DateTime type. + + The value regarded as the Null date. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. + + + + + Allows you to parse a new value that is about to be assigned to the CalendarControlBase.EditValue property. + + + + + Called when a key is pressed. + + A object that comprises data related to the key event. + + + + Gets or sets whether the Calendar is read-only, and thus an end-user is not able to change the date selection (CalendarControlBase.SelectedRanges) and edit value (CalendarControlBase.EditValue/CalendarControlBase.DateTime). + + true if the Calendar is read-only; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Nullifies the object that handles the control events. + + + + + Gets or sets whether the control’s visual elements are aligned to support locales using right-to-left fonts. + + A enumeration value that specifies whether the control’s visual elements are aligned to support locales using right-to-left fonts. The DefaultBoolean.Default value is equivalent to DefaultBoolean.False. + + + + Gets or sets the number of months displayed vertically. + + The number of months displayed vertically. + + + + Gets or sets the selected date ranges (DateRange objects). + Each DateRange object identifies dates that are EQUAL OR GREATER THAN the DateRange.StartDate and LESS THAN the DateRange.EndDate. Thus the last date is excluded from the range. + + A collection of selected date ranges. + + + + This property is obsolete. Use the CalendarControlBase.SelectedRanges property instead. + + + + + Gets or sets whether calendar date ranges are selected strictly from day to day being clicked, or through the entire weeks containing those days. + + A enumeration value that specifies how an end-user selects date ranges. + + + + Fires when the selection changes. + + + + + Gets the ending date of the selection. The SelectionEnd date is excluded from the selection. + + The ending date of the selection. + + + + Gets or sets whether a single date, or multiple dates can be simultaneously selected. + + The selection mode. + + + + Gets the first date of the selection. + + The first date of the selection. + + + + Clears the selection and sets the selection to the specified date range. + + The range to be selected. +The object specifies dates that lie in the range between the DateRange.StartDate (including this date) and the DateRange.EndDate (excluding this date). + + + + Clears the selection and sets the selection to the specified date range. + + The first date of a range (this date is included into the selection) + The last date of a range (this date is NOT included in the selection). + + + + Clears the selection and sets the selection to the specified date. + + The date to be selected. + + + + Gets whether the Cancel button is displayed. + + A enumeration value that specifies whether the Cancel button is displayed. + + + + Gets or sets the visibility of the Clear button, which clears the current selection, sets the CalendarControlBase.EditValue property to null and the CalendarControlBase.DateTime property to the CalendarControlBase.NullDate value. + + true if the Clear button is visible; otherwise, false. + + + + Gets or sets whether the calendar footer is displayed. + + True, to show the calendar footer; otherwise, false. + + + + Gets or sets whether the calendar header is displayed. + + True, to show the calendar header; otherwise, false. + + + + Gets or sets the visibility of month names for each month. + + true if the month name is displayed above each month; otherwise, false. + + + + Gets or sets the visibility of buttons that let you navigate between months. + + The visibility of buttons that let you navigate between months. The DefaultBoolean.Default value is equivalent to True. + + + + Gets whether the OK button is displayed. + + Always DefaultBoolean.False. + + + + Gets or sets the visibility of the Today button. + + The visibility of the Today button. + + + + Gets or sets whether to display week numbers in the calendar. + + The visibility of week numbers in the calendar. + + + + Gets or sets the visibility of buttons that let you navigate between years. + + The visibility of buttons that let you navigate between years. + + + + Allows you to mark certain dates as “special” dates. These dates will be painted using the dedicated settings provided by the CalendarControlBase.CalendarAppearance object. + + + + + Allows you to assign an ICalendarSpecialDateProvider object that can mark certain dates as “special” to highlight them in a custom manner, as specified by the dedicated appearance settings of the CalendarControlBase.CalendarAppearance object. + + An object that marks certain dates as “special”. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether changing the CalendarControlBase.DateTime/CalendarControlBase.EditValue property updates the current selection. + + true if the current selection is automatically set to the edit date (CalendarControlBase.DateTime/CalendarControlBase.EditValue) once the edit date is changed; otherwise false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the width, in pixels, of the edit box that allows end-users to edit the time portion of the edit value. + + An integer value that specifies the width, in pixels, of the time portion edit box. + + + + Gets or sets the date that is regarded as Today’s date. + + The date that is regarded as Today’s date. + + + + Gets or sets the border color of the Today cell. + + The border color of the Today cell. + + + + Gets or sets whether the same day (as in the current month) is selected in another month when you navigate from the current month to that month. + + true if the same day is selected in another month when you navigate from the current month to that month; otherwise, false. + + + + Gets or sets whether the same range of days (as in the current month) is automatically selected in another month when you navigate from the current month to that month. The CalendarControlBase.SyncSelectionWithEditValue property must be set to false to support this feature. + + true if the same range of days is automatically selected in another month when you navigate from the current month to that month; otherwise, false. + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for the Calendar Control. + + A enumeration value that specifies whether or not the calendar employs the DirectX rendering. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.False. + + + + Gets or sets the current date grouping View. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets which date grouping Views are available in Vista display mode. + + A value that specifies which date grouping Views are available in Vista display mode. + + + + Gets or sets the length of days of the week abbreviations. + + The length of days of the week abbreviations. + + + + Gets or sets a rule which determines the first week of the year. + + The rule that determines the first week of the year. + + + + Lists modes for displaying dates which do not belong to a current month but are displayed to fill in the first or last row. + + + + + If the calendar displays several months, only dates before the first month and after the last month shown are visible. + + + + + + Lists modes which determine what dates become selected when selection extends. + + + + + Selects entire weeks + + + + + Does not automatically extend the selection to the week’s start and end. + + + + + Contains data for the ImageSlider.CanGetNextPrevImage event. + + + + + Creates a new instance of the class with a specific sliding direction. + + true for sliding forward; otherwise, false. + + + + Gets or sets whether an image in the current sliding direction can be displayed. If not - corresponding navigation button will be disabled. + + true if an image in the current sliding direction can be displayed; otherwise, false. + + + + Specifies the image sliding direction (true for sliding forward, false for sliding backwards). + + true for an image sliding forward; otherwise, false. + + + + Provides data for the RepositoryItem.EditValueChanging event. + + + + + Creates a new object. + + An object representing the editor’s value. This value is assigned to the ChangingEventArgs.OldValue property. + An object representing the value about to be assigned to the editor. This value is assigned to the ChangingEventArgs.NewValue property. + true if the event should be canceled; otherwise, false. + + + + Creates a new object. + + An object representing the editor’s value. This value is assigned to the ChangingEventArgs.OldValue property. + An object representing the value about to be assigned to the editor. This value is assigned to the ChangingEventArgs.NewValue property. + + + + For internal use. + + + + + + For internal use. + + + + + + Gets or sets the value which is about to be assigned to the editor. Setting the NewValue property is not supported if the editor uses masked input (RepositoryItemTextEdit.Mask). + + An object representing the editor’s potential value. + + + + Gets the editor’s value. + + An object representing the editor’s value. + + + + Represents a method that will handle the RepositoryItem.EditValueChanging event. + + The event sender (typically the descendant). + A object containing data related to the event. + + + + Represents an item within the and controls. + + + + + Creates a new object with default settings. + + + + + Creates a new object and instantiates the ListBoxItem.Value and CheckedListBoxItem.CheckState properties. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + true if the item is checked; otherwise, false. This value is assigned to the CheckedListBoxItem.CheckState property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + A enumeration member representing the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + true if the item is enabled; otherwise, false. This value is assigned to the CheckedListBoxItem.Enabled property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + A enumeration member representing the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + true to enable the item; otherwise, false. This value is assigned to the CheckedListBoxItem.Enabled property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + A enumeration member representing the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified value, description and check state. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + A enumeration member representing the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + + + + Initializes a new instance of the class with the specified value and description. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string representing the item’s display text. This value is assigned to the CheckedListBoxItem.Description property. + + + + Initializes a new instance of the class with custom settings. + + An object which represents the item’s value. This value is assigned to the ListBoxItem.Value property. + A enumeration member specifying the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + true if the item is enabled; otherwise, false. This value is assigned to the CheckedListBoxItem.Enabled property. + + + + Creates a new object and instantiates the ListBoxItem.Value and CheckedListBoxItem.CheckState properties. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A enumeration member representing the item’s state. This value is assigned to the CheckedListBoxItem.CheckState property. + + + + Creates a new object and instantiates the ListBoxItem.Value property. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + + + + Gets or sets the item’s state. + + A enumeration member specifying the item’s state. + + + + Gets or sets the item’s display text. + + A string that specifies the item’s display text. + + + + Gets or set whether an end-user can change the item’s state. + + true if the item is enabled and an end-user can change its state; otherwise, false. + + + + Converts a value of the Nullable Boolean type to the System.Windows.Forms.CheckState type. + + A Nullable Boolean value to be converted. + A value converted to the System.Windows.Forms.CheckState type. + + + + Converts a check state to a Nullable<Boolean> value. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A CheckedState enumeration value to be converted. + A Nullable<Boolean> value. + + + + Inverts the item’s check state. + + + + + Returns the text representation of the current item. + + A string that specifies the text representation of the current object. + + + + Represents the CheckedListBoxControl‘s item collection. + + + + + Creates a new object. + + + + + Initializes a new instance of the class with the specified capacity. + + A value to initialize the collection’s Capacity property. + + + + Creates a new item with the specified value and state and appends it to the collection. + + An object which represents the item’s value. + true if the item is checked; otherwise, false . + A zero-based integer value representing the new item’s index. + + + + Creates a new item with the specified value and state and appends it to the collection. + + An object which represents the item’s value. + A Nullable Boolean value that represents the item’s check state. + A zero-based integer value representing the new item’s index. + + + + Adds a new item with the specified settings to the collection. + + An object that represents the item’s value. This value is used to initialize the ListBoxItem.Value property. + A string representing the item’s display text. This value is used to initialize the CheckedListBoxItem.Description property. + A enumeration member which specifies the item’s state. This value is used to initialize the CheckedListBoxItem.CheckState property. + A Boolean value that specifies whether the created item must be enabled. This value is used to initialize the CheckedListBoxItem.Enabled property. + A zero-based integer value that specifies the new item’s index. + + + + Adds a new item with the specified value and description to the collection. + + An object that represents the item’s value. This value is used to initialize the ListBoxItem.Value property. + A string representing the item’s display text. This value is used to initialize the CheckedListBoxItem.Description property. + A zero-based integer value that specifies the new item’s index. + + + + Creates a new item with the specified settings and appends it to the collection. + + An object which represents the item’s value. + A enumeration member which specifies the item’s state. + true if the item is enabled; otherwise, false. + A zero-based integer value representing the new item’s index. + + + + Creates a new item with the specified value and check state and appends it to the collection. + + An object which represents the item’s value. + A enumeration member which specifies the item’s state. + A zero-based integer value representing the new item’s index. + + + + Adds a new item with the specified value to the collection. + + An object that represents the item’s value. + A zero-based integer value that specifies the new item’s index. + + + + Adds an array of items to the collection. + + An array of objects to be added to the collection. + + + + Returns whether the specified item belongs to the current collection. + + The item to locate in the collection. + true if the specified item belongs to the collection; otherwise false. + + + + Returns a list of checked items’ values. + + A list of checked items. + + + + Returns the zero-based index of the specified in the collection, or, if the specified value is not a object, returns the index of the item that contains this value in its CheckedListBoxItem.Value property. + + A object whose index in the collection needs to be returned. Or, a value (CheckedListBoxItem.Value) of the item whose index needs to be returned. + A zero-based index of the required item. + + + + Gets or sets an item at the specified position within the collection. + + An integer value representing the zero-based index of the required item. If the index is negative or exceeds the last available index, an exception is thrown. + An object representing the item at the specified position within the collection. + + + + Returns an item that has the specified value. + + An object that represent’s the value of the item to be retrieved. + A object whose value matches the specified object. + + + + Provides data for the RepositoryItemPopupBase.Closed event. + + + + + Initializes a new instance of the class. + + A value specifying how an editor’s dropdown window is closed. This value is assigned to the ClosedEventArgs.CloseMode property. + + + + Gets a value that specifies why the popup editor’s dropdown window was closed. + + A value specifying the reason the dropdown window was closed. + + + + Represents a method for handling the RepositoryItemPopupBase.Closed event of the control descendants. + + The event source. + A object that contains event data. + + + + Provides data for the RepositoryItemPopupBase.CloseUp event. + + + + + Initializes a new instance of the class with the specified settings. + + An Object assigned to the CloseUpEventArgs.Value property. + true if the CloseUpEventArgs.Value is accepted; otherwise, false. + A enumeration value that indicates available methods to close the popup editor’s dropdown window. + A BlobSimpleButtonType enumeration value that specifies a button associated with this object. + + + + Initializes a new instance of the class with the specified values. + + An object representing the value to assign to the editor’s edit value. This value is assigned to the CloseUpEventArgs.Value property. + true if the value must be accepted; otherwise, false. This value is assigned to the CloseUpEventArgs.AcceptValue property. + A enumeration value which specifies how a dropdown editor’s popup window was closed. This value is assigned to the CloseUpEventArgs.CloseMode property. + + + + Creates a new instance of the class and initializes its properties based upon specified parameters. + + An object to initialize the CloseUpEventArgs.Value property value. + A value to initialize the CloseUpEventArgs.AcceptValue property. + + + + Creates a new instance of the class. + + An object to initialize the CloseUpEventArgs.Value property. + + + + Gets or sets a value indicating whether CloseUpEventArgs.Value should be accepted or discarded. + + true if the value must be accepted; otherwise, false. + + + + Gets a value indicating how the popup editor’s dropdown window was closed. + + A enumeration value which specifies how the dropdown editor’s popup window was closed. + + + + Returns which popup button has been pressed by an end-user. + + A DevExpress.XtraEditors.Popup.BlobSimpleButtonType object that specifies the button that has been pressed by an end-user. + + + + Gets or sets a value to assign to the editor’s edit value. + + The value to assign to the editor’s BaseEdit.EditValue property. + + + + Represents a method that will handle the RepositoryItemPopupBase.CloseUp event of a popup editor. + + The event source. This identifies the editor whose popup window is closed. + A object containing data related to the event. + + + + Specifies the style used to represent the selected color in a control. + + + + + The selected color is represented as an integer value in the edit box. + The following image shows a color editor with the RepositoryItemColorEdit.ColorText property set to Integer. + + + + + + The selected color is represented as a human-readable string in the edit box. If the selected color is one of predefined colors, display text specifies its common name (such as Aquamarine, Highlight or WindowText). Otherwise, the string consists of the ARGB (alpha, red, green, and blue) components. + The following screenshots show color editors when the RepositoryItemColorEdit.ColorText property is set to Native. + + + + + + + + + + + Serves as the base for the class representing image combo box items. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class and sets its ComboBoxItem.Value to the specified parameter. + + An object to initialize the ComboBoxItem.Value property. + + + + Gets or sets the item value. This value is assigned to the editor’s edit value when users select the item. + + The item value. + + + + Represents a collection of items within a combo box editor. + + + + + Initializes a new instance of the class with specified settings. + + + + + Creates and initializes a new instance of the class. + + The object for which the item collection should be created. + + + + Adds a new item to the current collection. + + The object representing the new item in the collection. + The position to which the new element was inserted. + + + + Adds the items from the specified collection to the current collection. + + An object which implements the interface. + + + + Adds an array of items to the collection. + + An array of objects representing items for the combo box editor. + + + + Copies items from the source collection to the current collection. + + The source collection whose items are copied to the current collection. + + + + Locks the by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called. + + + + + Occurs when changing the item collection. + + + + + Gets a value indicating whether the specified object is an element of the current collection. + + An object to locate in the collection. + true if the specified object belongs to the collection; otherwise, false. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets the textual representation of the specified item. + + The item for which to return its text representation. + The string representing the specified item. + + + + Gets the zero-based index of the specified object in the item collection. + + The item to locate in the collection. + The zero-based index of the specified item in the current collection, if found; otherwise, -1. + + + + Inserts a new element at the specified position. + + The zero-based index specifying the position at which the item should be inserted. + The item to insert. + + + + Gets or sets an item at the specified position. + + The zero-based index of the item to return. + The item at the specified position. + + + + Removes the specified object from the collection. + + The item to remove from the collection. + + + + Provides data for the RepositoryItem.FormatEditValue and RepositoryItem.ParseEditValue events. + + + + + Creates a new object with default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Creates a new object and initializes its ConvertEditValueEventArgs.Value property. + + An object representing the editor’s new value. This value is assigned to the ConvertEditValueEventArgs.Value property. + + + + Gets or sets a value specifying whether default edit value conversion/formatting is required. + + true to prohibit default edit value conversion/formatting; otherwise, false. + + + + Gets or sets either the edit or the display value of an editor. + + An object specifying either the edit or the display value of an editor. + + + + Represents a method that will handle the RepositoryItem.ParseEditValue and RepositoryItem.FormatEditValue events. + + The event sender (typically a descendant). + A object containing data related to the event. + + + + Provides data for the RepositoryItem.CustomDisplayText event. + + + + + Initializes a new instance of the class. + + An object that represents an editor’s value. This value is assigned to the CustomDisplayTextEventArgs.Value property. + A string that represents an editor’s display text. This value is assigned to the CustomDisplayTextEventArgs.DisplayText property. + + + + Gets or sets an editor’s display text. + + A string value that represents an editor’s display text. + + + + Gets an editor’s current value. + + An object that represents an editor’s current value. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the editor which fires the event. + A object that contains data for the event. + + + + Specifies the response of a editor to an invalid value. + + + + + Invalid data is replaced with the value of the RepositoryItemDateEdit.NullDate property. + + + + + Invalid data is replaced with the current date. + + + + + Invalid data is replaced with the previously validated date. + + + + + Contains values specifying the editor drawing detail level. + + + + + Specifies the full detail level of editor drawing. In this case editors display their buttons. + + + + + Specifies the minimum detail level of editor drawing. In this case, editor’s buttons are not displayed. + + + + + An editor button displayed in a control or its descendant. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + The value to initialize the button’s EditorButton.Image property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A string value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageAlignment property. + The value to initialize the button’s EditorButton.Image property. + The value to initialize the button’s EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A Boolean value that specifies whether specific pixels in the button’s image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property. + + + + Initializes a new instance of the class. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageLocation property. + The value to initialize the button’s EditorButton.Image property. + The value to initialize the button’s EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + A enumeration value which specifies the alignment of the glyph relative to the button’s caption. This value is used to initiailize the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if an editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + A enumeration value which specifies the alignment of the glyph relative to the button’s caption. This value is used to initialize the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if an editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + A enumeration value which specifies the alignment of the glyph relative to the button’s caption. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if an editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + A enumeration value which specifies the alignment of the glyph relative to the button’s caption. This value is used to initialize the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if an editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + A enumeration value which specifies the alignment of the glyph relative to the button’s caption. This value is used to initialize the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance with the specified property values. + + The value to initialize the button’s EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageLocation property. + The value to initialize the button’s EditorButton.Image property. + The value to initialize the button’s EditorButton.Shortcut property. + + + + Initializes a new instance of the class. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageAlignment property. + The value to initialize the button’s EditorButton.Image property. + The value to initialize the button’s image. + The value to initialize the button’s EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A Boolean value that specifies whether specific pixels in the button’s image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property. + + + + Initializes a new instance with the specified property values. + + The value to initialize the button’s EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageLocation property. + The value to initialize the button’s EditorButton.Image property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + An object which provides the appearance settings used to paint the button in hovered state. This value is assigned to the EditorButton.AppearanceHovered property. + An object which provides the appearance settings used to paint the button in pressed state. This value is assigned to the EditorButton.AppearancePressed property. + An object which provides the appearance settings used to paint the button in disabled state. This value is assigned to the EditorButton.AppearanceDisabled property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A ToolTipAnchor enumeration value that specifies how the tooltip is anchored. This value is assigned to the EditorButton.ToolTipAnchor property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + An object which provides the appearance settings used to paint the button in hovered state. This value is assigned to the EditorButton.AppearanceHovered property. + An object which provides the appearance settings used to paint the button in pressed state. This value is assigned to the EditorButton.AppearancePressed property. + An object which provides the appearance settings used to paint the button in disabled state. This value is assigned to the EditorButton.AppearanceDisabled property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true, if the button is aligned to the editor’s left edge; false, if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + An object which provides the appearance settings used to paint the button in hovered state. This value is assigned to the EditorButton.AppearanceHovered property. + An object which provides the appearance settings used to paint the button in pressed state. This value is assigned to the EditorButton.AppearancePressed property. + An object which provides the appearance settings used to paint the button in disabled state. This value is assigned to the EditorButton.AppearanceDisabled property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A Boolean value that specifies whether specific pixels in the button’s image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property. + + + + Initializes a new instance of the class. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + The value to initialize the button’s EditorButton.Enabled property. + The value to initialize the button’s EditorButton.Visible property. + The value to initialize the button’s EditorButton.IsLeft property. + The value to initialize the button’s EditorButton.ImageLocation property. + The value to initialize the button’s EditorButton.Image property. + The value to initialize the button’s EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + A value which identifies the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A Boolean value that specifies whether specific pixels in the button’s image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object for the current button. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + + + + Initializes a new instance of the class with the specified settings. + + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + A value that specifies the uniform resource identifier of the image in the DX Image Gallery to be displayed on the button’s surface. + A object which represents the button’s shortcut. This value is assigned to the EditorButton.Shortcut property. + An object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property. + An object which provides the appearance settings used to paint the button in hovered state. This value is assigned to the EditorButton.AppearanceHovered property. + An object which provides the appearance settings used to paint the button in pressed state. This value is assigned to the EditorButton.AppearancePressed property. + An object which provides the appearance settings used to paint the button in disabled state. This value is assigned to the EditorButton.AppearanceDisabled property. + A value which specifies the button’s tool tip. This value is assigned to the EditorButton.ToolTip property. + An object to be associated with the button. This value is assigned to the EditorButton.Tag property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + A Boolean value that specifies whether specific pixels in the button’s image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the button’s image type. This value is assigned to the EditorButton.Kind property. + A value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property. + An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property. + true if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property. + true if the button is aligned to the editor’s left edge; false if the button is aligned to the editor’s right edge. This value is assigned to the EditorButton.IsLeft property. + An value that specifies the position of the button’s image relative to the text. This value is assigned to the EditorButton.ImageLocation property. + A object which represents the image displayed on the button’s surface. This value is assigned to the EditorButton.Image property. + + + + Initializes a new instance with the specified property values. + + The value to initialize the button’s EditorButton.Kind property. + The value to initialize the button’s EditorButton.ToolTip property. + + + + Initializes a new instance of the class with a button type. + + A type value representing the kind of button to create. + + + + Initializes a new instance of the class with the specified settings. + + An EditorButtonImageOptions object that specifies image options. This value is assigned to the EditorButton.ImageOptions property. + A value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property. + A object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property. + + + + Initializes a new instance of the class with the specified property values. + + The value to initialize the button’s EditorButton.Tag property with. + The value to initialize the button’s EditorButton.Kind property with. + + + + Provides access to the button’s appearance settings. + + A object which provides the appearance settings used to paint the button. + + + + Provides access to the appearance settings applied when the current button is disabled. + + An object that specifies the appearance settings applied when the current button is disabled. + + + + Provides access to the appearance settings applied when the mouse pointer passes over the current button. + + An object that specifies the appearance settings applied when the current button is hovered over with the mouse pointer. + + + + Provides access to the appearance settings applied when the current button is clicked. + + An object that specifies the appearance settings applied when the current button is clicked. + + + + Copies all properties of the specified button to the current object. + + The source object whose properties must be copied. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets the caption text of the editor button. + + A string specifying button caption text. + + + + Occurs when the properties defining the button’s look and feel are changed. + + + + + Occurs when the current editor button is clicked. + + + + + Gets the buttons collection that owns the current button. + + An object which represents a collection of editor buttons. + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Releases all unmanaged resources used by an . + + + + + Gets or sets whether a selected is highlighted when the mouse interacts with the button. + + true, to highlight a selected ; otherwise, false. + + + + Gets or sets the Boolean value that determines whether a user can perform actions on the current editor button. + + true if an editor button is enabled and a user can perform actions on it; otherwise, false. + + + + Gets or sets whether specific colors in the button’s image are transparent, when displayed. + + true if specific colors in the button’s image are transparent, when displayed; otherwise, false. + + + + Gets or sets the glyph alignment relative to its caption. + + The value of the type specifies the alignment of the glyph relative to the button’s caption. + + + + Gets or sets a custom image to display on the button. + + A object that specifies the image displayed on the button surface. + + + + Gets or sets the alignment of the image displayed within the button. + + A enumeration member which specifies the image’s alignment. + + + + Specifies the position of the button’s image relative to the text. + + A value that specifies the alignment of the button’s image relative to the text. + + + + Provides access to all properties that allow you to assign and customize an icon for this . + + A DevExpress.XtraEditors.Controls.EditorButtonImageOptions object that stores all properties that allow you to assign and customize an icon for this . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current button. + A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). + + A object that specifies the uniform resource identifier of the image to be displayed in the current button. + + + + Gets the button’s position within the owning collection. + + A zero-based integer representing the button’s position. + + + + Gets or sets whether the button is the default button. + + true if the button is the default button; otherwise, false. + + + + Gets or sets the location of the button within the current control. + + true if the button is aligned to the left; false if the button is aligned to the right. + + + + Gets or sets the type of image to display within the button. + + A enumerator value that specifies the type of image to display within the button. + + + + Raises the EditorButton.Click event. + + + + + Raises the EditorButton.Click event. + + + + + Reverts the button’s properties to its default values. + + + + + Removes the object that has been assigned to the editor button. + + + + + Gets or sets a shortcut used to activate the button’s functionality. + + The object specifying the shortcut for the current button. + + + + Gets or sets a for the current button. + + A object associated with the button. + + + + Gets or sets a value that identifies the current button. + + A that identifies the current instance. + + + + Gets or sets the button’s regular tooltip. + + A string which specifies the button’s regular tooltip. + + + + Gets or sets whether the tooltip is anchored relative to the mouse pointer or the button. + + A DevExpress.Utils.ToolTipAnchor value that specifies whether the tooltip is anchored relative to the mouse pointer or the button. By Default, the behavior depends on the ToolTipController.ToolTipAnchor property. + + + + Returns the text representation of the current object. + + A string that specifies the text representation of the current object. + + + + Gets or sets the visibility status of the current button. + + true if the button is visible; otherwise, false. + + + + Gets or sets the button’s width. + + The button’s width in pixels. Setting it to -1 enables auto width. + + + + Represents a collection of editor buttons in a control or its descendant. + + + + + Creates and initializes a new instance of the class. + + + + + Adds the specified button to the button collection. + + The object specifying the button to insert into the collection. + The zero-based index of the button within the collection. + + + + Adds an array of buttons to the current button collection. + + An array of objects to add to the current button collection. + + + + Copies buttons from the specified object to the current button collection. + + The source button collection. + + + + Occurs when changing the current button collection. + + + + + Gets a value indicating whether the specified button belongs to the current collection. + + The button object to locate in the collection. + true if the button belongs to the current button collection; otherwise, false. + + + + Gets the position of the specified button in the current button collection. + + The object to locate in the collection. + The zero-based index of the button in the collection. + + + + Inserts the specified button at a given position. + + The zero-based index at which the button is inserted. + The button to insert to the collection. + + + + Gets a button at the specified position. + + The zero-based index of the button to return. + An object at the specified position in the current collection. + + + + Removes the specified button from the current collection. + + A button to remove from the collection. + true if removed from the collection; otherwise, false. + + + + Returns the text representation of the current object. + + A string that specifies the text representation of the current object. + + + + Gets the number of visible buttons in the collection. + + The number of visible buttons in the collection. + + + + Lists values that specify when the editor’s RepositoryItem.EditValueChanged event should be raised. + + + + + The RepositoryItem.EditValueChanged event fires after an end-user has stopped editing (typing text) and a specified amount of time (RepositoryItem.EditValueChangedFiringDelay/RepositoryItem.EditValueChangedDelay) has passed. + + + + + The RepositoryItem.EditValueChanged event fires immediately after the editor’s value has been changed by an end-user. For the , and controls, the event fires after you move focus between date/time placeholders. + + + + + Represents the base class for arguments passed to exception handling events. + + + + + Creates a new object. + + A string value specifying the error description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A object representing the exception that raised the event. This value is assigned to the ExceptionEventArgs.Exception property. + + + + Creates a new object. + + A string value specifying the error description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A string value specifying the error message box caption. This value is assigned to the ExceptionEventArgs.WindowCaption property. + A object representing the exception that raised the event. This value is assigned to the ExceptionEventArgs.Exception property. + A enumeration value specifying the response to entering an invalid value. This value is assigned to the ExceptionEventArgs.ExceptionMode property. + + + + Gets or sets the error description to be displayed in the message box/tooltip. + + A string value specifying the text to display in the message box/tooltip. + + + + Gets the exception that caused the event. + + A object representing the exception that caused the event. + + + + Gets or sets the type of response to supplying invalid values. + + A enumeration value specifying the response type. + + + + Gets or sets the caption of the error message box. + + A string value specifying the caption of the error message box. + + + + Represents the method for handling events which take an object as a parameter. + + The source of the event. + A object that contains event data. + + + + Specifies how an exception should be handled. + + + + + A control displays a tooltip or message box with an error description specified by the ExceptionEventArgs.ErrorText property. A tooltip is displayed for invalid cells. A message box is displayed for invalid rows (records). + + + + + Discards new data and reverts to an old value. + + + + + + + A control suppresses an error message box/tooltip and exceptions. Values remain unchanged. + + + + + A control throws an exception specified by the ExceptionEventArgs.Exception property. + + + + + Lists the values that determine the display mode for column filter. + + + + + Filter buttons are rendered as buttons. They are displayed when a column is filtered or when the mouse cursor hovers over the column header. + + + + + + The same as the FilterButtonShowMode.SmartTag option. + + + + + Filter buttons are rendered as small tags. They are displayed when a column is filtered or when the mouse cursor hovers over the column header. + + + + + + Contains data for the ImageSlider.GetImage event. + + + + + Initializes a new instance of the class with custom settings. + + true if the image query is the result of a forward image slide; otherwise, false. + true if the image query is the result of a backward image slide; otherwise, false. + true if the image required is the very first to be uploaded; otherwise, false. + true if a new image was successfully displayed within the current ; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + true if the first image within the needs to be displayed; otherwise, false. + true if the last image within the needs to be displayed; otherwise, false. + + + + Gets or sets whether the currently displayed image was successfully changed. + + true if the currently displayed image was successfully changed; otherwise, false. + + + + Gets or sets an image that is be displayed within the current . + + An Image object that is to be displayed within the current . + + + + Gets or sets if the image to be displayed is the first image within the . + + true if the image to be displayed is the first image within the ; otherwise, false. + + + + Gets or sets if the image to be displayed is the last image within the . + + true if the image to be displayed is the last image within the ; otherwise, false. + + + + Gets or sets whether the image query is the result of an image sliding forward. + + true if whether the image query is the result of an image sliding forward; otherwise, false. + + + + Gets or sets whether the image query is the result of an image sliding backward. + + true if the image query is the result of an image sliding backwards; otherwise, false. + + + + Gets or sets whether the image required is the very first to be uploaded by the current . + + true if the image required is the very first to be uploaded; otherwise, false. + + + + Provides data for the RepositoryItemLookUpEdit.GetNotInListValue event. + + + + + Creates an instance of the class. + + The field to initialize the GetNotInListValueEventArgs.FieldName property. + The value for the RecordIndex property. + + + + Gets the field for which you should provide the value for the specified record. + + The field name for which to return the value. + + + + Gets or sets a field value. + + A field value. + + + + Represents a method that will handle the RepositoryItemLookUpEdit.GetNotInListValue event. + + The control which fires the event. + A object that contains event data. + + + + Lists values that specify which functionality is invoked as a result of a click on a column header within the lookup editor’s dropdown list. + + + + + Clicking a column’s header selects this column for incremental searching. + + + + + Clicking a column’s header sorts the data by that column. + + + + + Contains values specifying the manner in which the hour portion is displayed. + + + + + The hour format obtained from the operation system time settings. + + + + + The hour portion varies from 00 to 12. A time suffix is displayed. + + + + + + The hour portion varies from 00 to 24. + + + + + + Represents an individual item in controls. + + + + + Creates a new instance of the class and sets all its properties to their default values. + + + + + Creates a new instance of the class and initializes the item’s ImageComboBoxItem.ImageIndex property. + + The value to initialize the ImageComboBoxItem.ImageIndex property. + + + + Creates a new instance of the class and initializes the item’s value and image index. + + The object to initialize the item’s ComboBoxItem.Value property. + The value to initialize the item’s ImageComboBoxItem.ImageIndex property. + + + + Creates a new instance of the class and initializes the item’s value. + + The object to initialize the item’s ComboBoxItem.Value property. + + + + Creates a new instance of the class and initializes the item’s caption and image index. + + The string to initialize the item’s ImageComboBoxItem.Description property. + The value to initialize the ImageComboBoxItem.ImageIndex property. + + + + Creates a new instance of the class and initializes its properties to the specified values. + + The string to initialize the item’s ImageComboBoxItem.Description property. + The object to initialize the item’s ComboBoxItem.Value property. + The value to initialize the item’s ImageComboBoxItem.ImageIndex property. + + + + Creates a new instance of the class and initializes the item’s value and caption. + + The string to initialze the item’s ImageComboBoxItem.Description. + The value to initialize the item’s ComboBoxItem.Value. + + + + Creates a new instance of the class and initializes the item’s caption. + + The string to initialize the ImageComboBoxItem.Description property. + + + + Copies all properties of the specified object to the current item. + + The source item whose properties must be copied to the current item. + + + + Gets or sets the item’s display text. + + The string that specifies the item’s display text. + + + + Gets or sets the index of the image associated with the item. + + The index of the image associated with the item. + + + + Gets the source that provides images for image combo box items. + + An which represents the source of images. + + + + Returns the textual representation of the item. + + The string representing the current item. + + + + Represents a collection of items displayed within the dropdown list of editors. + + + + + Creates a new instance of the class. + + The object for which the collection is created. + + + + Adds a new item to the current collection. + + A new item to insert into the collection. + The position into which the new element was inserted. + + + + Adds a new item to the current collection. + + A value that specifies the new item’s caption. This value is assigned to the item’s ImageComboBoxItem.Description property. + A that specifies the value associated with the new item. This value is assigned to the item’s ComboBoxItem.Value property. + An integer value that specifies the index of the image linked to the new item. This value is assigned to the item’s ImageComboBoxItem.ImageIndex property. + The position to which the new element was inserted. + + + + Adds new items to the collection that will represent elements of the specified enumeration. Allows you to assign integer values to the items’ Value property. + + A object which is the required enumeration. + true if values for generated items should store numeric enumerator values ; false if these values should store constant enumerator names instead. + + + + Adds new items to the collection that will represent elements of the specified enumeration. + + A object which represents the required enumeration. + + + + Adds new items to the collection that will represent elements of the specified enumeration. + + + + + Adds new items that represent elements of the specified enumeration to the control. Allows you to customize item descriptions and specify whether underlying integer values are assigned to the item values. + + A System.Converter delegate that generates item descriptions to be displayed. + true, if values for generated items should store numeric enumerator values; false, if these values should store constant enumerator names instead. + The type of the required enumeration. + + + + Adds new items to the collection that will represent elements of the specified enumeration. The display captions of the items are generated by the specified converter. + + A System.Converter delegate that will generate item display captions. + + + + Retrieves images from the target image list, assigned to either the RepositoryItemImageComboBox.SmallImages or RepositoryItemImageComboBox.LargeImages property. + + An Object that stores images to be added. + + + + Adds an array of items to the collection. + + An array of objects representing items for the image combo box editor. + + + + Returns the item in the current collection that contains the specified value. + + A ComboBoxItem value. + The object within the current collection containing the specified value. + + + + Gets the text representation of the specified item. + + The item for which to return its text representation. + The string representing the specified item. + + + + Gets or sets an item at the specified position. + + The zero-based index of the item to return. + The item at the specified position. + + + + Represents a single item in the collection. + + + + + Creates a new object. + + + + + Creates a new object and instantiates its ListBoxItem.Value and ImageListBoxItem.ImageIndex properties. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + An integer value representing the zero-based index of the image displayed in the item. This value is assigned to the ImageListBoxItem.ImageIndex property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + An object that stores image-related options. This value is assigned to the ImageListBoxItem.ImageOptions property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + An integer value representing the zero-based index of the image displayed in the item. This value is assigned to the ImageListBoxItem.ImageIndex property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + An image displayed by the item. This value is assigned to the ImageListBoxItem.Image property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + An integer value representing the zero-based index of the image displayed in the item. This value is assigned to the ImageListBoxItem.ImageIndex property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + An integer value representing the zero-based index of the image displayed in the item. This value is assigned to the ImageListBoxItem.ImageIndex property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + Custom data associated with the item. This value is assigned to the ListBoxItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + A string that specifies the item’s display text. This value is assigned to the ImageListBoxItem.Description property. + + + + Creates a new object and instantiates its ListBoxItem.Value property. + + An object representing the item’s value. This value is assigned to the ListBoxItem.Value property. + + + + Gets or sets the item’s display text. + + A string that specifies the item’s display text. + + + + Gets or sets an image displayed by this item. This property has a lower priority than the ImageListBoxItem.ImageIndex property. + + A object specifying an image displayed by this item. + + + + Specifies the index of the item’s image. + + An integer value representing the zero-based index of the item’s image. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.XtraEditors.Controls.ImageListBoxItemImageOptions object that stores image-related options. + + + + Gets the source of images which provides images for image list box items. + + An which represents the source of images. + + + + Returns the textual representation of the item. + + The string representing the current item. + + + + Represents the collection of items displayed in the ImageListBoxControl. + + + + + Creates a new object. + + + + + Creates a new item with the specified settings and appends it to the collection. + + An object which represents the item’s value. + A zero-based integer specifying the index of the item’s image. + A zero-based integer value representing the new item’s index. + + + + Adds a new item with the specified value to the collection. + + An object that represents the item’s value. + A zero-based integer value that specifies the new item’s index within the collection. + + + + Adds an array of items to the collection. + + An array of objects to be added to the collection. + + + + Returns the zero-based index of the specified in the collection, or, if the specified value is not a object, returns the index of the item that contains this value in its ImageListBoxItem.Value property. + + A object whose index in the collection needs to be returned. Or, a value (ImageListBoxItem.Value) of the item whose index needs to be returned. + A zero-based index of the required item. + + + + Gets or sets an item at the specified position. + + An integer value representing the item’s zero-based index within the collection. If negative or exceeds the maximum available index, an exception is raised. + An object representing the item at the specified position within the collection. + + + + The control that allows your end-users to browse through a collection of images using two navigation buttons. Supports animation effects when navigating between images. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether sliding from the last to the first image and vice versa is enabled. + + true if sliding from the last to the first image and vice versa is enabled; otherwise, false. + + + + Gets or sets whether the control automatically slides images in the forward or backward direction. + + An DevExpress.XtraEditors.Controls.AutoSlide enumeration value, such as None, Forward or Backward, that specifies whether the control automatically slides images in the forward or backward direction. + + + + Gets or sets the show duration per slide, in milliseconds, in the auto slide mode. + + An integer value that specifies the show duration per slide, in milliseconds, in the auto slide mode. + + + + Returns information on the image slider elements located at the specified point. + + A System.Drawing.Point structure specifying the test point coordinates relative to the top-left corner of the control. + An ImageSliderHitInfo object containing information about the image slider elements located at the test point. + + + + Occurs when an is ready to slide to the next/previous image and navigation buttons are to be displayed. + + + + + Fires when a context button is clicked. + + + + + Provides access to the settings applied to the context buttons displayed in the image slider, and panels containing these buttons. + + A ContextItemCollectionOptions object that comprises settings applied to the context buttons displayed in the image slider, and panels containing these buttons. + + + + Provides access to the collection of context buttons displayed in the image slider. + + A ContextItemCollection object that represents the collection of context buttons displayed in the image slider. + + + + Gets a currently displayed image within the object. + + An that is the currently displayed image within the specified . + + + + Gets or sets the index of the image currently displayed in the control. + + An integer value that specifies the zero-based index of the image currently displayed in the control. + + + + Occurs when the ‘s currently displayed image is about to change. + + + + + Gets the index of the currently displayed image within the current . + + An Int32 value that is the index of the currently displayed image within the current . + + + + Occurs when an needs to change the currently displayed image to another image. + + + + + Fires when the ImageSlider.CurrentImage property value changes. + + + + + Gets or sets the source of images to be displayed in the control. + + A that represents an image collection providing images for the control. + + + + Gets a collection of images presented by an object. + + A object specifying images within an object. + + + + Gets whether the control is currently being initialized. + + true if the control is currently being initialized; otherwise, false. + + + + Gets or sets the way an image is aligned within the container. + + An object defining the way an image is aligned within the container. + + + + Gets an image that follows the ImageSlider.CurrentImage within the specified object. + + An object that follows the ImageSlider.CurrentImage within the specified object. + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + Gets or sets whether the buttons that slide images back and forward are displayed. + + Default or True if the buttons that slide images back and forward are displayed; otherwise, False. + + + + Sets the index of the image currently displayed within the current . The method’s parameter specifies whether to use the slide animation. + + An integer value that specifies the zero-based index of the image to be displayed. + true, to use the slide animation; otherwise, false. + + + + Sets the index of the image currently displayed within the current . + + An Int32 value that is the index of the image to be displayed. + + + + Starts animation of the image currently displayed. + + + + + Stops animation of the image currently displayed. + + + + + Updates the currently displayed image. + + + + + Gets or sets whether images are painted grayed out when the control is disabled. + + true if images are painted grayed out when the control is disabled; otherwise, false. Default is true. + + + + Gets or sets whether the current operates in the Virtual Mode. + + true if the current operates in the Virtual Mode; otherwise, false. + + + + Contains values specifying the inplace editor types. + + + + + This member supports the .NET framework infrastructure and is not intended to be used in your code. + + + + + This member supports the .NET framework infrastructure and is not intended to be used in your code. + + + + + This member supports the .NET framework infrastructure and is not intended to be used in your code. + + + + + This member supports the .NET framework infrastructure and is not intended to be used in your code. + + + + + Provides data for events that occur when assigning an invalid value to a container control cell. + + + + + Initializes a new instance of the class. + + A string to initialize the ExceptionEventArgs.ErrorText property. + A object to initialize the ExceptionEventArgs.Exception property. + An object to initialize the InvalidValueExceptionEventArgs.Value property. + + + + Creates a new object. + + A string value specifying the error’s description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A string value specifying the error message box caption. This value is assigned to the ExceptionEventArgs.WindowCaption property. + A object representing the exception that raised the event. This value is assigned to the ExceptionEventArgs.Exception property. + A enumeration value specifying the response to entering an invalid value. This value is assigned to the ExceptionEventArgs.ExceptionMode property. + An object representing the invalid value. This value is assigned to the InvalidValueExceptionEventArgs.Value property. + + + + Gets an invalid value that caused the exception. + + An object representing the invalid value. + + + + Represents the method for handling events which take an object as a parameter. + + Event source. + An object that contains event data. + + + + Provides data for the BaseCheckedListBoxControl.ItemCheck event of check list box controls. + + + + + Initializes a new instance of the class. + + The position of the item in the check list box item collection, whose state has changed. This value is assigned to the ItemCheckEventArgs.Index property. + A value representing the new state for the item. This value is assigned to the ItemCheckEventArgs.State property. + + + + Gets the index of the item whose state was changed. + + An integer value specifying the item’s position in the item collection. + + + + Gets the state of the item. + + A value representing the checked state of the item. + + + + Represents a method for handling the BaseCheckedListBoxControl.ItemCheck event of a check list box control. + + The event source. This represents the check list box control. + An object containing event data. + + + + Provides data for the BaseCheckedListBoxControl.ItemChecking event of check list box controls. + + + + + Initializes a new instance of the class. + + The position of the item whose state is about to be changed in the check list box item collection. + A value representing the new checked value for the item. + A value representing the old checked value for the item. + + + + Gets the index of the item whose checked state is about to be changed. + + The position of the item in the BaseCheckedListBoxControl.Items collection. + + + + Gets or sets a new checked state for the item. + + A value representing the new checked state for the item. + + + + Gets the item’s previous checked state. + + A value representing the previous checked state of the item. + + + + Represents a method for handling the BaseCheckedListBoxControl.ItemChecking event of a check list box control. + + The event source. This represents the check list box control. + An object containing event data. + + + + Represents a single item in the collection. + + + + + Gets or sets custom data associated with the current object. + + Custom data associated with the current object. + + + + Returns an item’s equivalent string representation. + + A value representing the current item. + + + + Gets or sets the item’s value. + + An object representing the item’s value. + + + + Represents the collection of items displayed in the ListBoxControl. + + + + + Creates a new object. + + + + + Initializes a new instance of the class with the specified capacity. + + A value to initialize the collection’s Capacity property. + + + + Adds the specified item to the end of the collection. + + An object which represents the item to append. + A zero-based integer representing the item’s position within the collection. + + + + Populates this with items generated from values of the specific enumeration. Allows generated items to store numeric enumeration values instead of enumeration constant names. This overload should be used only for the class descendants. + + A type of enumeration whose values should be used to generate items. + true if values for generated items should store numeric enumerator values ; false if these values should store constant enumerator names instead. This parameter is not in effect when the method is called for objects, since their child items do not have the Value-Description property pair. + + + + Populates this with items generated from values of the specific enumeration. + + A Type of enumeration whose values should be used to generate items. + + + + Populates this with items generated from values of the specific enumeration. + + + + + Adds new items that represent elements of the specified enumeration to the control. Allows you to customize item descriptions and specify whether underlying integer values are assigned to the item values. + + A System.Converter delegate that generates item descriptions to be displayed. + true, if values for generated items should store numeric enumerator values; false, if these values should store constant enumerator names instead. + The type of the required enumeration. + + + + Populates this with items generated from values of the specific enumeration and replaces default item descriptions. This overload should be used only for the class descendants. + + A Delegate that encapsulates a method which replaces generated items’ captions. This parameter is not in effect when the method is called for objects, since their child items do not have the Value-Description property pair. + + + + Adds an array of items to the collection. + + An array of objects to be added to the collection. + + + + Locks the by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called. + + + + + Returns whether the specified item belongs to the current collection. + + The item to locate in the collection. + true if the specified item belongs to the collection; otherwise false. + + + + Gets the number of items in the collection. + + An integer value that specifies the number of items in the collection. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Returns the position of the specified item within the collection. + + The object representing the item to locate within the collection. + An integer value representing the zero-based index of the specified item within the collection. -1 if the specified item is not found. + + + + Creates a new item and adds it to the specified position within the collection. + + An integer value representing the zero-based index at which the created item should be inserted. If negative or exceeds the number of elements within the collection an exception is thrown. + An object representing the inserted item. + + + + Gets or sets an item at the specified position within the collection. + + An integer value representing the zero-based index of the item. If negative or exceeds the number of elements, an exception is raised. + An object representing the item at the specified position. + + + + Occurs after the item collection has been changed. + + + + + Removes the specified item from the collection. + + An object representing the item to be removed from the collection. + + + + Represents an object providing a means to localize editor interface elements. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets a localizer object providing localization of the editors’ interface at runtime. + + A Localizer descendant which is used to localize the editors’ interface at runtime. + + + + Creates and returns an EditResLocalizer object containing resources for the thread’s language and regional settings (culture). + + An EditResLocalizer object containing resources for the thread’s culture. + + + + Returns an XtraLocalizer object representing resources based on the thread’s language and regional settings (culture). + + An object representing resources based on the thread’s culture. + + + + Gets the string, localized by the current , for the specified user interface element. + + A String value specifying the UI element whose localized text content is to be obtained. + A String value that is the localized text content of the specific UI element. + + + + A column for a lookup editor. + + + + + Creates an instance of the class and sets its properties to default values. + + + + + Creates an instance of the class and initializes its field name, caption and width. + + The value to initialize the LookUpColumnInfo.FieldName property. + The value to initialize the LookUpColumnInfo.Width property. + The value to initialize the LookUpColumnInfo.Caption property. + + + + Creates an instance of the class and sets its field name and width to the specified values. + + The value to initialize the LookUpColumnInfo.FieldName property. + The value to initialize the LookUpColumnInfo.Width property. + + + + Initializes a new instance of the class with the specified settings. + + A string representing the field name whose values are displayed in the column. This value is used to initialize the LookUpColumnInfo.FieldName property. + A string representing the column’s caption. This value is used to initialize the LookUpColumnInfo.Caption property. + An integer value specifying the width of the current column. This value is used to initialize the LookUpColumnInfo.Width property. + A value specifying the type of formatting applied when displaying column values. This value is used to initialize the LookUpColumnInfo.FormatType property. + A string specifying the pattern used to format column values. This value is used to initialize the LookUpColumnInfo.FormatString property. + A Boolean value specifying the visibility of the current column. This value is used to initialize the LookUpColumnInfo.Visible property. + A value specifying the horizontal alignment of the column’s values. This value is used to initialize the LookUpColumnInfo.Alignment property. + A value specifying the sort order for the column. This value is used to initialize the LookUpColumnInfo.SortOrder property. + A value that specifies whether data sorting is enabled for the column. This value is used to initialize the LookUpColumnInfo.SortOrder property. + + + + Initializes a new instance of the class with the specified settings. + + A string representing the field name whose values are displayed in the column. This value is used to initialize the LookUpColumnInfo.FieldName property. + A string representing the column’s caption. This value is used to initialize the LookUpColumnInfo.Caption property. + An integer value specifying the width of the current column. This value is used to initialize the LookUpColumnInfo.Width property. + A value specifying the type of formatting applied when displaying column values. This value is used to initialize the LookUpColumnInfo.FormatType property. + A string specifying the pattern used to format column values. This value is used to initialize the LookUpColumnInfo.FormatString property. + A Boolean value specifying the visibility of the current column. This value is used to initialize the LookUpColumnInfo.Visible property. + A value specifying the horizontal alignment of the column’s values. This value is used to initialize the LookUpColumnInfo.Alignment property. + A value specifying the sort order for the column. This value is used to initialize the LookUpColumnInfo.SortOrder property. + + + + Creates an instance of the class and sets all its properties to specified values. + + The value to initialize the LookUpColumnInfo.FieldName property. + The value to initialize the LookUpColumnInfo.Caption property. + The value to initialize the LookUpColumnInfo.Width property. + The value to initialize the LookUpColumnInfo.FormatType property. + The value to initialize the LookUpColumnInfo.FormatString property. + The value to initialize the LookUpColumnInfo.Visible property. + The value to initialize the LookUpColumnInfo.Alignment property. + + + + Creates an instance of the class and initializes its field name, caption and width. + + The value to initialize the LookUpColumnInfo.FieldName property. + The value to initialize the LookUpColumnInfo.Caption property. + The value to initialize the LookUpColumnInfo.Width property. + + + + Initializes a new instance of the class with the specified field name and caption. + + The value to initialize the LookUpColumnInfo.FieldName property. + The value to initialize the LookUpColumnInfo.Caption property. + + + + Creates an instance of the class and sets its field name to the specified value. + + The value to initialize the LookUpColumnInfo.FieldName property. + + + + Gets or sets the horizontal alignment of column values within the current column. + + A value specifying the alignment of the column’s contents. + + + + Gets or sets whether the column supports data sorting. + + A value that specifies whether data sorting is enabled for the current column. + + + + Copies properties of the source column to the current instance. + + The source column whose properties must be copied. + + + + Gets or sets the column’s caption. + + The string representing the column’s caption. + + + + Gets or sets the field name whose values are displayed in the column. + + The name of the field whose values are displayed in the column. + + + + Specifies the pattern used to format column values when the LookUpColumnInfo.FormatType is not set to FormatType.None. + + The pattern used to format column values. + + + + Gets or sets the type of formatting applied when displaying column values. + + The value specifying the format type. + + + + Returns the LookUpEdit control that owns the collection containing the current object. + + The owner of the collection containing the current object. + + + + Gets or sets the sort order applied to the current column. + + A value specifying the column’s sort order. + + + + Returns the textual representation of the current object. + + A string that specifies the textual representation of the current object. + + + + Gets or sets the visibility of the current column. + + true if the column is visible; otherwise, false. + + + + Gets or sets the width of the current column. + + The width of the current column. + + + + A collection of columns for a lookup editor. + + + + + Creates an instance of the class. + + + + + Initializes a new instance of the class with the specified owner. + + An owner of the created collection. + + + + Adds a new column to the current collection. + + A column to add to the collection. + The position into which the new element was inserted. + + + + Adds an array of columns to the collection. + + An array of objects representing columns for the lookup editor. + + + + Copies columns from the source collection to the current one. + + The source collection whose columns are copied to the current collection. + + + + Occurs on changing the column collection + + + + + Creates a new column for a lookup editor. + + A object that has been created. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + true if the specified is equal to the current ; otherwise, false. + + + + Returns a visible lookup column at the specified visible index. + + An integer which specifies the zero-based visible index of the column which should be returned. + A object which represents the visible lookup column at the specified index. + + + + Gets the zero-based index of the specified column in the item collection. + + The column to locate in the collection. + The zero-based index of the specified column in the current collection, if found; otherwise, -1. + + + + Gets a column at the specified position. + + The zero-based index of the column to return. + A column at the specified position. + + + + Gets a column by its field name. + + The field name of the column to return. + The first column encountered whose LookUpColumnInfo.FieldName property matches the specified field name. + + + + Removes the specified column from the collection. + + The column to remove from the collection. + + + + Gets the number of visible lookup columns. + + An integer which represents the number of visible lookup columns. + + + + Gets the zero-based index of the specified visible column. + + The column found. + The zero-based index of the specified visible column. + + + + Provides arguments for the LookUpEdit.AutoSearch and GridLookUpEdit.AutoSearch events. + + + + + Allows you to change how the lookup editor searches for items in its drop-down panel. + + If a text entered into the editor text box contains whitespaces, the editor splits this string into separate logical blocks. This parameter specifies how these blocks are combined into a search query. + The condition according to which the editor searches for the string entered into its text box. + + + + Allows you to change how the lookup editor searches for items in its drop-down panel. + + A text to compare with data source records. + If a text entered into the editor text box contains whitespaces, the editor splits this string into separate logical blocks. This parameter specifies how these blocks are combined into a search query. + The condition according to which the editor searches for the string entered into its text box. + + + + Allows you to change how the lookup editor searches for items in its drop-down panel. + + The name of a field whose values should be compared with the search text. + A text to compare with data source records. + If a text entered into the editor text box contains whitespaces, the editor splits this string into separate logical blocks. This parameter specifies how these blocks are combined into a search query. + The condition according to which the editor searches for the string entered into its text box. + + + + Allows you to change how the lookup editor searches for items in its drop-down panel. + + Names of fields whose values should be compared with the search text. + A text to compare with data source records. + If a text entered into the editor text box contains whitespaces, the editor splits this string into separate logical blocks. This parameter specifies how these blocks are combined into a search query. + The condition according to which the editor searches for the string entered into its text box. + + + + Provides data for the LookUpEdit.AutoSuggest and GridLookUpEdit.AutoSuggest events. + + + + + An object that cancels the Task assigned to the GetSuggestions method. This object is generated when you call the Cancel method. + + Cancels the Task that should retrieve lookup items. + + + + Clears the editor drop-down menu, removing all items returned by the GetSuggestions task. + + true, to remove drop-down menu items; otherwise, false. + + + + Gets or sets a System.Threading.Tasks.Task object that returns the collection of items, which match the current user text. These items are displayed in the editor drop-down menu. + + A Task that returns the collection of items for the editor’s drop-down menu. + + + + Sets the minimum duration for the loading indicator that plays while the GetSuggestion task is ongoing. This allows you to prevent this animation from flickering when the task completes too quickly. + + The minimum display duration (in milliseconds). + + + + Sets the minimum duration for the loading indicator that plays while the GetSuggestion task is ongoing. This allows you to prevent this animation from flickering when the task completes too quickly. + + A TimeSpan object that specifies the minimum duration for the loading indicator. + + + + Sets a that defines the items the or display in AutoSuggest mode. + + A that returns a list of database entries for the editor’s drop-down menu. + The type of entries the processes. + + + + A base class for the AutoSearch and AutoSuggest event parameters. + + + + + Cancels the Task assigned to the QuerySuggestions parameter. + + true to cancel the QuerySuggestions task, false to run it. + + + + Removes any active highlight pattern from lookup items. + + + + + This member supports internal infrastucture and is not intended to be used in code. + + + + + + Highlights any part of a record that matches the text entered by a user. + + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Highlights any part of a record that matches the given text. + + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Highlights any part of a record that belongs to the specific data field and matches the given text. + + A data field whose values can be highlighted. + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Highlights any part of a record that belongs to certain data fields and matches the given text. + + A list of data fields whose values should be highlighted. + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + In every data field value, selects the first found text portion that matches the user text. + + A CompareOptions enumeration value that specifies the string comparison mode. + + + + In every data field value, selects the first found text sequence if it matches the user text. + + A Text that should be highlighted if it matches the user text. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Selects the first found text sequence if it matches the user text and belongs to the specific data field. + + A Field whose values can be highlighted. + A Text that should be highlighted if it matches the user text. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Selects the first found text portion that matches the user text and belongs to any of the given data fields. + + Fields whose values can be hightlighted. + A Text that should be highlighted if it matches the user text. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + If a record starts with the user text, this text portion is highlighted. + + A CompareOptions enumeration value that specifies the string comparison mode. + + + + If a record starts with the given text, this text portion is higlighted. + + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + If a record belongs to the given data field and starts with the specific text, this text portion is highlighted. + + A field whose values can be highlighted. + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + If record belongs to any of the given data fields and starts with the specific text, this text portion is higlighted. + + Fields whose values can be highlighted. + A text that should be highlighted. + A CompareOptions enumeration value that specifies the string comparison mode. + + + + Sets a specific highlight range. + + A function that must return a highlight range. A highlight range is a structure that contains the first hightlighted char position, and the length of highlighted charecters’ sequence. + + + + Sets a specific highlight range. + + A function that must return a highlight range. A highlight range is a structure that contains the first hightlighted char position, and the length of highlighted charecters’ sequence. + + + + Sets specific highlight ranges. + + A function that must return a highlight ranges’ array. A highlight range is a structure that contains the first hightlighted char position, and the length of highlighted charecters’ sequence. + + + + Returns the current user text. + + The current user text. + + + + Contains values that identify how an item has beed added to the control. + + + + + A new item has been added by an end-user. + + + + + For internal use. + + + + + Provides data for the RepositoryItemHyperLinkEdit.OpenLink event. + + + + + Creates an instance of the class. + + The value to initialize the OpenLinkEventArgs.EditValue property. + + + + Gets or sets the object representing the command to execute. + + The object representing the command to execute. + + + + Gets or sets whether default execution of the hyperlink command is required. + + true if the event is handled and no default processing is required; false, if the editor should execute the command after performing your RepositoryItemHyperLinkEdit.OpenLink event handler. + + + + Represents a method for handling the RepositoryItemHyperLinkEdit.OpenLink event of a control. + + The event source. + A object that contains event data. + + + + Enumerates output formats for the Image Editor dialog. + + + + + PNG image format. + + + + + The output and original image format match. + + + + + Represents an individual item within an image combo box editor. + + + + + Creates an image combobox item and sets all its properties to their default values. + + + + + Creates an image combobox item and sets its image index to the specified value. + + The value to initialize the ImageComboBoxItem.ImageIndex property. + + + + Creates an image combobox item and initializes the item’s value and image index. + + The object to initialize the item’s ComboBoxItem.Value property. + The value to initialize the item’s ImageComboBoxItem.ImageIndex property. + + + + Creates an image combo box item and initializes the item’s value. + + The object to initialize the item’s ComboBoxItem.Value property. + + + + Creates an image combobox item and initializes the item’s caption and image index. + + The string to initialize the item’s ImageComboBoxItem.Description property. + The value to initialize the ImageComboBoxItem.ImageIndex property. + + + + Creates an image combobox item and initializes its properties to the specified values. + + The string to initialize the item’s ImageComboBoxItem.Description property. + The object to initialize the item’s ComboBoxItem.Value property. + The value to initialize the item’s ImageComboBoxItem.ImageIndex property. + + + + Creates an image combobox item and initializes the item’s value and caption. + + The string to initialze the item’s ImageComboBoxItem.Description. + The value to initialize the item’s ComboBoxItem.Value. + + + + Creates an image combobox item and initializes the item’s caption. + + The string to initialize the ImageComboBoxItem.Description property. + + + + Contains values that specify how a mask is aligned relative to an image in the control. + + + + + A mask is aligned at the center of the bottom side of the image. + + + + + A mask is aligned to the bottom left corner of the image. + + + + + A mask is aligned to the bottom right corner of the image. + + + + + The same as ZoomInside. + + + + + A mask is aligned to the middle of the image. + + + + + A mask is aligned at the center of the left side of the image. + + + + + A mask is aligned at the center of the right side of the image. + + + + + A mask is stretched to fit the image’s boundaries. + + + + + A mask is aligned at the center of the top side of the image. + + + + + A mask is aligned to the top left corner of the image. + + + + + A mask is aligned to the top right corner of the image. + + + + + A mask is stretched proportionally within the image’s boundaries. + + + + + Enumerates mask types for the control. + + + + + A circle mask. + + + + + + Enables the use of a custom mask, assigned to the PictureEditOptionsMask.CustomMask property. + + + + + + No mask is applied. + + + + + A rounded rectangle mask. + Use the PictureEditOptionsMask.RectCornerRadius property to specify the radius of rounded corners. + + + + + + Contains settings that customize the Image Editor dialog. + + + + + Initializes a new instance of the class with specified settings. + + + + + Copies settings from the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Gets or sets the output image format for the Image Editor dialog. + + + + + Resets the object’s properties to their default values. + + + + + Contains settings that enable masked mode and allow you to customize the masked mode behavior. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The owner of the created object. + + + + Copies all settings from the options object passed as the parameter and assigns them to the current object. + + A descendant whose settings are assigned to the current object. + + + + For internal use. + + + + + Gets or sets a custom mask, applied to the target image in PictureEditMaskType.Custom mode. + + A custom mask. + + + + Gets or sets the outer margin of the mask. + + The outer margin of the mask. + + + + Gets or sets how a mask is aligned relative to the target image. + + A value that specifies how a mask is aligned relative to the target image. The Default value is equivalent to ZoomInside. + + + + Gets or sets which mask type is applied. + + A value that specifies the mask type applied to the image. + + + + Gets or sets the offset of the mask relative to the image. + + The offset of the mask relative to the image. + + + + Gets or sets the radius of rounded corners for the RoundedRect mask type (see PictureEditOptionsMask.MaskType). + + The radius of rounded corners for the RoundedRect mask type. + + + + Gets or sets a custom size for the mask. + + A custom size for the mask. + + + + Specifies the size mode of the image contained within a or editor. + + + + + A picture is not stretched. + + + + + An image is displayed as is if its actual size is smaller than the size of the container. If the image size is larger than the container’s size, the image is shrunk proportionally to fit the container’s bounds. + + + + + A picture is stretched in order to fit within the area of an editor (or editor’s dropdown window). + + + + + A picture is stretched horizontally. Its height remains unchanged. + + + + + A picture is stretched vertically. Its width remains unchanged. + + + + + A picture is stretched proportionally. The picture fits within the area of an editor (or editor’s dropdown window) at least in one direction. + + + + + Lists values that specify how the control stores images pasted via the editor’s context menu + + + + + A pasted image is stored to the editor’s edit value as an array of bytes. + + + + + A pasted image is stored either as an object or as an array of bytes to the editor’s edit value, depending upon the type of the current edit value. If the editor’s EditValue currently stores an object, the newly pasted image will be stored as an as well. Otherwise, the new image will be stored as an array of bytes. + + + + + A pasted image is stored to the editor’s edit value as an object. + + + + + Contains styles for popup window borders. + + + + + Borders are flat. This style is reserved for future use. Currently, the Default style is the same as the PopupBorderStyles.Flat style. + + + + + + Borders are flat. + + + + + + There are no borders. + + + + + + Borders are thin and drawn using a single line. + + + + + + Borders are three-dimensional. + + + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The item’s index. + The value in the data source. + + + + Gets or sets whether to select the item. + + true to select the item; otherwise, false. + + + + Gets the value in the data source. + + The value in the data source. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The item’s index. + The value posted to the data source. + The item’s selection state. + + + + Gets whether the item is selected. + + true if the item is selected; otherwise, false. + + + + Gets the value in the data source. + + The value in the data source. + + + + Gets or sets the value posted to the data source. + + The value posted to the data source. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The item’s index. + The item’s selection state. + + + + Gets whether the item is selected. + + true if the item is selected; otherwise, false. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The item’s index. + The item’s selection state. + + + + Gets or sets whether to cancel the change selection operation. + + true to cancel the change selection operation; otherwise, false. + + + + Gets whether the item is selected. + + true if the item is selected; otherwise, false. + + + + Provides data for the RepositoryItemLookUpEditBase.ProcessNewValue event. + + + + + Creates an instance of the class. + + The value to initialize the ProcessNewValueEventArgs.DisplayValue property. + + + + Gets or sets the value entered by the end-user. + + An object representing the value entered by the end-user. + + + + Gets or sets a value specifying whether the lookup editor must locate the newly inserted record. + + true if the editor must locate the newly inserted record; otherwise false. + + + + Represents a method that will handle the RepositoryItemLookUpEditBase.ProcessNewValue event. + + The control which fires the event. + A object that contains event data + + + + Lists values specifying the control’s direction. + + + + + Sets progress direction to horizontal. + + + + + + Sets progress direction to vertical. + + + + + + Contains values specifying the style of the progress bar’s indicator. + + + + + Presents the progress indicator as a series of small blocks. Not supported in Office2003, WindowsXP and skin paint themes, which always use the Solid indicator style. + + + + + + Presents the progress indicator as a solid bar. + + + + + + Provides data for the RepositoryItemCheckEdit.QueryCheckStateByValue event. + + + + + Creates an instance of the class. + + A expression representing the check editor’s edited value. This value is assigned to the QueryCheckStateByValueEventArgs.Value property. + + + + Use this property to set the check state that corresponds to the current edit value. + + The check state. + + + + Gets the current edit value. + + A expression representing an editor’s edit value. + + + + Represents a method that will handle the RepositoryItemCheckEdit.QueryCheckStateByValue event. + + The event sender (typically the check edit control). + A object containing data related to the event. + + + + Serves as the base for classes providing data for RepositoryItemCheckEdit.QueryCheckStateByValue and RepositoryItemCheckEdit.QueryValueByCheckState events. + + + + + Creates an instance of the class. + + A expression representing the check editor’s edited value. + A enumeration value representing the editor’s check state. + + + + Gets or sets whether the event is handled and no default processing is required. + + true if default event processing is not required; false if default processing is required. + + + + Provides data for the RepositoryItemPopupContainerEdit.QueryDisplayText and RepositoryItemPopupGalleryEdit.QueryDisplayText events. + + + + + Creates a new object. + + An object representing the editor value whose textual representation is to be specified. This value is assigned to the QueryDisplayTextEventArgs.EditValue property. + A string value representing the editor’s value within the text box. This value is assigned to the QueryDisplayTextEventArgs.DisplayText property. + + + + Gets or sets the text to display in the edit box. + + A string value specifying the editor’s formatted display text. + + + + Gets the current edit value. + + An object representing the editor’s value. + + + + Represents a method that will handle the RepositoryItemPopupContainerEdit.QueryDisplayText and RepositoryItemPopupGalleryEdit.QueryDisplayText events. + + The event source. This identifies the popup container editor for which the event is fired. + A object containing data related to the event. + + + + Provides data for the RepositoryItemPopupContainerEdit.QueryResultValue event. + + + + + Creates a new object. + + An object specifying the editor value. This value is assigned to the QueryResultValueEventArgs.Value property. + + + + Gets or sets the editor value. + + An object specifying editor value. + + + + Represents a method that will handle the PopupContainerEdit.QueryResultValue event of a popup container editor. + + The event source. This identifies the popup container editor for which the event is fired. + A object containing data related to the event. + + + + Provides data for the RepositoryItemCheckEdit.QueryValueByCheckState event. + + + + + Creates an instance of the class. + + A enumeration value representing the current check state of the check editor. This value is assigned to the QueryValueByCheckStateEventArgs.CheckState property. + + + + Gets the editor’s current check state. + + The editor’s check state. + + + + Use this property to set the edit value that corresponds to the current check state. + + The edit value. + + + + Represents a method that will handle the RepositoryItemCheckEdit.QueryValueByCheckState event. + + The event sender (typically the check edit control). + A object containing data related to the event. + + + + Represents a single item in the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with the specified settings. + + A value identifying the item. This value is assigned to the RadioGroupItem.Value property. + A value that specifies the item’s display text. This value is assigned to the RadioGroupItem.Description property. + A Boolean value that specifies whether the item is enabled. This value is assigned to the RadioGroupItem.Enabled property. + An Object that contains custom data. This value is assigned to the RadioGroupItem.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + A value identifying the item. This value is assigned to the RadioGroupItem.Value property. + A value that specifies the item’s display text. This value is assigned to the RadioGroupItem.Description property. + A Boolean value that specifies whether the item is enabled. This value is assigned to the RadioGroupItem.Enabled property. + + + + Initializes a new instance of the class and sets its RadioGroupItem.Value and RadioGroupItem.Description to the specified parameters. + + An object to initialize the RadioGroupItem.Value property. + An object to initialize the RadioGroupItem.Description property. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Occurs when any item property is changed. + + + + + Returns a copy of the current object. + + A representing a clone of the current object. + + + + Gets or sets the item’s caption. + + The string identifying the item’s caption. + + + + Gets or sets whether the item is enabled. + + A Boolean value that specifies whether the item is enabled; otherwise, false. + + + + Gets or sets an object that contains custom data for the current object. + + An Object that contains custom data for the current . + + + + Returns the text representation of the item. + + The string representing the current item. + + + + Gets or sets the value associated with the current item. + + An object representing the value associated with the current item. + + + + Represents a collection of items within a radio group editor. + + + + + Initializes a new instance of the class. + + + + + Adds a new item to the current radio group collection. + + The object representing the new item in the collection. + + + + Adds items that represent elements of the specified enumeration to the current collection. Enumeration values are converted to string values using the specified method to represent item descriptions. + + A System.Type object that is an enumeration whose elements should be added to the current collection. + A method that converts enumeration values to string values. The returned string representation for each enumeration value is assigned to the RadioGroupItem.Description property of the corresponding added to the current collection. + + + + Adds items to the collection that represent elements of the specified enumeration. + + A System.Type object that is an enumeration whose elements are to be added to the RadioGroup control. + + + + Adds items that represent elements of the specified enumeration to the current collection. + + + + + Adds items that represent elements of the specified enumeration to the current collection. Enumeration values are converted to string values using the specified method to represent item descriptions. + + A method that converts enumeration values to string values. The returned string representation for each enumeration value is assigned to the RadioGroupItem.Description property of the corresponding added to the current collection. + + + + Adds an array of items to the collection. + + An array of objects representing items for the radio group editor. + + + + Copies properties of the source repository item to the current object. + + A object whose settings are assigned to the current object. + + + + Locks the by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called. + + + + + Occurs when changing the item collection. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets a radio group item by its value. + + The value to search. + The object with the value specified. + + + + Gets the index of a radio group item by its value. + + The value to search. + The integer value that specifies the item’s index. + + + + Gets the zero-based index of the specified object in the item collection. + + The item to locate in the collection. + The zero-based index of the specified item in the current collection, if found; otherwise, -1. + + + + Inserts a new element at the specified position within the collection. + + The position at which the item should be inserted. + The RadioGroupItemCollection.Item to insert. + + + + Gets or sets an item at the specified position. + + The zero-based index of the item to return. + The item at the specified position. + + + + Removes the specified item from the collection. + + The to remove from the collection. + + + + Enumerates search modes for a lookup edior. + + + + + Enables the automatic completion feature. In this mode, when the dropdown is closed, the text in the edit box is automatically completed if it matches a RepositoryItemLookUpEditBase.DisplayMember field value of one of dropdown rows. + + When the dropdown is open, the automatic completion feature is disabled but the editor allows you to perform an incremental search in the same manner as when SearchMode.OnlyInPopup mode is active. + The found value is immediately applied to the editor as a user types a query. + + + + + Enables the incremental filtering feature. When you type within the edit box, the editor automatically opens the dropdown window and displays only records whose RepositoryItemLookUpEditBase.DisplayMember field value starts with the characters typed. Other records are not displayed. If you enter a value that does not match any record, the dropdown window will not contain any rows. + The found value is immediately applied to the editor as a user types a query. + + + + + + The editor unlocks its text box and allows users to type in text. Data source records that match this text are shown in the drop-down panel. The user must highlight the required row to select a new value. + + Handle the AutoSearch event to fine-tune the search: + + ```csharp + void LookUpEdit_AutoSearchComplete(object sender, LookUpEditAutoSearchCompleteEventArgs e) { + LookUpEdit le = sender as LookUpEdit; + var popupForm = le.GetPopupEditForm(); + if(popupForm != null) { + + + } + } + ``` + + + + + + The editor fires the AutoSuggest event that you should handle to assign an asynchronous Task. The task must check the user text currently entered into the editor’s text box, and return a list of matching items. This list is then assigned to the editor’s DataSource property. + + + + + + The incremental search is enabled only when the dropdown window is open. If the window is closed, the user can modify the text in the edit box. However these changes are ignored. + When the dropdown is open the incremental search is performed against the column whose index is specified by the RepositoryItemLookUpEdit.AutoSearchColumnIndex property. The header of this column contains the search icon (binoculars). The user can click a specific column header to perform the search against this column. + + + + + + Determines the behavior of a popup control when a user clicks within its text region. + + + + + A popup window is activated when a user double-clicks within the text region of a control. + Note: the value is in effect when the RepositoryItemButtonEdit.TextEditStyle property is set to TextEditStyles.Standard as well. + + + + + Clicking within the text region does not activate the popup window. A popup window appears only when pressing the RepositoryItemPopupBase.CloseUpKey key or Alt + DownArrow key, or calling the editor’s PopupBaseEdit.ShowPopup method. + + + + + A popup window is activated when a user clicks within the text region of a control. + + + + + Provides a base class for objects. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets the time required to switch to another image. + + An integer value that specifies the time, in milliseconds, required to switch to another image. + + + + Gets or sets the time of the fade-in animation effect for scroll buttons. + + An integer value that specifies the time of the fade-in animation effect for scroll buttons. + + + + Slides to the first image within the . + + + + + Slides to the last image within the . + + + + + Shifts to an image that follows the ImageSlider.CurrentImage. + + + + + Shifts back to an image that precedes the ImageSlider.CurrentImage. + + + + + Gets the period of time that it takes for an object to switch from one image to another. + + An Int64 value, indicating how many ticks it takes to switch to another image. + + + + An image collection for an control. + + + + + Initializes a new instance of the class with the specified settings. + + An ImageSlider that owns the newly created . + + + + Adds an item to the current collection and returns its index. + + An Image object to be added to the current . + An integer value indicating an index of the item added. + + + + Returns whether the current contains a specified image object. + + An Image object to check as to whether it belongs to the current . + true if the current contains a specified image object; otherwise, false. + + + + Returns an index of the specified Image object within the current . + + An Image object, whose index is to be obtained. + An integer value that defines an index of the specified Image object within the current . + + + + Places an image object at the specified position in the current . + + An integer value indicating a position within the current to which an image will be placed. + An Image object to be added to a specified position in the current . + + + + Provides indexed access to images stored within the . + + An integer value, specifying a position of the required Image object within the current + An Image object contained within the current at the specified position. + + + + Removes the specified image from the current . + + An Image object to be removed from the current . + + + + Gets an that owns the current . + + An that owns the current . + + + + Provides data for the RepositoryItemTextEdit.Spin event + + + + + Initializes a new instance of the class with the specified settings. + + A Boolean value that indicates whether the Up Arrow key or Up Spin button has been pressed, or the mouse wheel has been rotated up. This value is used to initialize the SpinEventArgs.IsSpinUp property. + + + + Gets or sets whether the event has been handled, and no default processing is required. + + A Boolean value that specifies that the event has been handled, and no default processing is required. + + + + A Boolean value that specifies whether the Up Arrow key or Up Spin button (in a control) has been pressed, or the mouse wheel has been rotated up. + + true if the Up Arrow key or Up Spin button (in a control) has been pressed, or the mouse wheel has been rotated up; otherwise, false. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the editor which fires the event. + A object that contains data for the event. + + + + Enumerates values that specify whether spin buttons in the , , and controls are oriented vertically or horizontally. + + + + + Spin buttons are oriented horizontally. + + + + + + Spin buttons are oriented vertically. + + + + + + Contains classes that contain style settings for scrollbars and progress bar items. + + + + + Contains values that specify the progress styles of items + + + + + The same as Range mode. + + + + + Highlights the selected item (SelectedItem), the previous items and the connectors between them. + + + + + + Highlights the selected item (SelectedItem) only. + + + + + + Contains values that specify the scrollbar’s styles. + + + + + The application’s default scrollbar. The scrollbar is visible if the items don’t fit inside the step progress bar. + Use the ScrollUIMode property to change the application’s scroll bar style. + + + + + The same as Fluent scroll mode. + + + + + The Fluent Design-inspired scroll bar. + + + + + Hides the scrollbar. + + + + + This member is not supported. + + + + + The application’s default scrollbar. The scrollbar is always visible. + Use the ScrollUIMode property to change the application’s scroll bar style. + + + + + Contains values corresponding to strings that can be localized. + + + + + Returns “All Rights Reserved.” + + + + + The caption of the Apply button displayed within the filter drop-down window within a PivotGrid control. + Return value: Apply + + + + + Represents the caption of the button used to delete the last digit of the displayed number in the editor. + Return value: Back + + + + + Represents the caption of the button used to clear the current calculation in the editor. + Return value: C + + + + + Represents the caption of the button used to clear the displayed number in the editor. + Return value: CE + + + + + Represents the caption of the button used to clear any number stored in memory of the editor. + Return value: MC + + + + + Represents the caption of the button used to recall the number stored in memory of the editor. + Return value: MR + + + + + Represents the caption of the button used to store the display number in memory of the editor. + Return value: MS + + + + + Represents the caption of the button used to add the displayed number to any number already in memory in the editor. + Return value: M+ + + + + + Represents the caption of the button used to calculate the square root of the displayed number in the editor. + Return value: sqrt + + + + + The string displayed in the edit box of the editor if an expression cannot be evaluated (division by zero, for instance). + Return value: Calculation Error + + + + + The notification displayed by the at design time. + Return value: Rendering is disabled at design time. + + + + + The notification displayed by the if the device is already in use in another application. + Return value: Cannot use the device, as it is already in use in another application. + + + + + The notification displayed by the if no capture device is found. + Return value: No webcam found. Check the webcam connection or the device settings. + + + + + The caption of the combo box that selects the active capture device in the Camera Settings form of the . + Return value: Active device: + + + + + The caption of the track bar that adjusts the brightness in the Camera Settings form of the . + Return value: Brightness: + + + + + The caption of the Camera Settings form of the . + Return value: Camera Settings + + + + + The caption of the track bar that adjusts the contrast in the Camera Settings form of the . + Return value: Contrast: + + + + + The caption of the Reset to defaults button in the Camera Settings form of the . + Return value: Reset to defaults + + + + + The caption of the check box that specifies the saturation setting in the Camera Settings form of the . + Return value: Desaturate: + + + + + The caption of the combo box that adjusts the resolution in the Camera Settings form of the . + Return value: Resolution: + + + + + The caption of the button to discard changes and close the dropdown window of a and editors. + Return value: Cancel + + + + + The default caption for the error message box. + Return value: Error + + + + + Returns “The interval between grid lines is too small to be represented in the range control.” + + + + + Returns “The interval between grid lines is too small to be represented in the range control.” + + + + + Returns “Max should be greater than or equal to min”. + + + + + Specifies the string corresponding to the checked state of the check edit. This string is displayed, for instance, in the filter dropdown of the Grid Control (or other) control. + Return value: Checked + + + + + Specifies the string corresponding to the indeterminate state of the check edit. This string is displayed, for instance, in the filter dropdown of the Grid Control (or other) control. + Return value: Indeterminate + + + + + Specifies the string corresponding to the unchecked state of the check edit. This string is displayed, for instance, in the filter dropdown of the Grid Control (or other) control. + Return value: Unchecked + + + + + Returns “Blue component should be in range 0..255”. + + + + + Returns “Brightness”. + + + + + Returns “Brightness component should be in range 0..100”. + + + + + Returns “Invalid hexadecimal value”. + + + + + Returns “Green component should be in range 0..255”. + + + + + Returns “Hue”. + + + + + Returns “Hue component should be in range 0..359”. + + + + + Returns “Luminance”. + + + + + Returns “Opacity”. + + + + + Returns “Opacity component should be in range 0..255”. + + + + + The caption of the Automatic button in the control. + Return value: Automatic + + + + + Returns “More Colors…” + + + + + Returns “Recent Colors”. + + + + + Returns “Standard Colors”. + + + + + Returns “Theme Colors”. + + + + + Returns “Red component should be in range 0..255”. + + + + + Returns “Saturation”. + + + + + Returns “Saturation component should be in range 0..100”. + + + + + Returns “Blue - White - Red”. + + + + + Returns “Emerald - Azure - Blue”. + + + + + Returns “Green - White - Red”. + + + + + Returns “Green - Yellow - Red”. + + + + + Returns “Purple - White - Azure”. + + + + + Returns “White - Azure”. + + + + + Returns “White - Green”. + + + + + Returns “White - Red”. + + + + + Returns “Yellow - Green”. + + + + + Returns “Yellow - Orange - Coral”. + + + + + Specifies the caption of the editor’s tab page displaying predefined custom colors. + Return value: Custom + + + + + Specifies the caption of the editor’s tab page displaying predefined system colors. + Return value: System + + + + + Specifies the caption of the editor’s tab page displaying predefined web colors. + Return value: Web + + + + + Returns “Web-Safe”. + + + + + Represents the text which identifies the name of an in-place editor within a container control. + The string which is identified by this enumeration value is used to initiliaze an editor’s BaseEdit.AccessibleName property when this editor is activated for in-place editing within container controls (eg. XtraGrid, XtraTreeList, etc). + + + + + Returns “Blue Data Bar”. + + + + + Returns “Blue Data Bar Gradient”. + + + + + Returns “Coral Data Bar”. + + + + + Returns “Coral Data Bar Gradient”. + + + + + Returns “Green Data Bar”. + + + + + Returns “Green Data Bar Gradient”. + + + + + Returns “Light Blue Data Bar”. + + + + + Returns “Light Blue Data Bar Gradient”. + + + + + Returns “Mint Data Bar”. + + + + + Returns “Mint Data Bar Gradient”. + + + + + Returns “Orange Data Bar”. + + + + + Returns “Orange Data Bar Gradient”. + + + + + Returns “Raspberry Data Bar”. + + + + + Returns “Raspberry Data Bar Gradient”. + + + + + Returns “Violet Data Bar”. + + + + + Returns “Violet Data Bar Gradient”. + + + + + Returns “Yellow Data Bar”. + + + + + Returns “Yellow Data Bar Gradient”. + + + + + Specifies the text string displayed in the and editors when no image is loaded. + Return value: Data empty + + + + + Returns “Changed”. + + + + + Returns “Decreased”. + + + + + Returns “Increased”. + + + + + The caption of the Clear button used to set the editor’s edit value to the RepositoryItemDateEdit.NullDate property value (null-date). + Return value: Clear + + + + + The caption of the Today button used to assign the current day to the edit value of the editor. + Return value: Today + + + + + Identifies the days item in controls in a Touch UI. + Return value: days + + + + + Returns “Default” + + + + + Returns “False” + + + + + Returns “True” + + + + + Returns “Add”. + + + + + Returns “Cancel”. + + + + + Returns “Properties”. + + + + + Returns “Items({0})”. + + + + + Returns “OK”. + + + + + Returns “Preview”. + + + + + Returns “Remove”. + + + + + Returns “Add {0}”. + + + + + Returns “Edit Formatting Rule”. + + + + + Returns “Field List ({0})”. + + + + + Returns “Advanced date and time operators”. + + + + + Returns “Avg”. + + + + + Returns “Count”. + + + + + Returns “Exists”. + + + + + Returns “Max”. + + + + + Returns “Min”. + + + + + Returns “Sum”. + + + + + Represents the caption of the AnyOf filter clause. + Return value: Is any of + + + + + Represents the caption of the BeginsWith filter clause. + Return value: Begins with + + + + + Represents the caption of the Between filter clause. + Return value: Is between + + + + + Represents the caption of the BetweenAnd filter clause. + Return value: and + + + + + Represents the caption of the Contains filter clause. + Return value: Contains + + + + + Represents the caption of the DoesNotContain filter clause. + Return value: Does not contain + + + + + Represents the caption of the DoesNotEqual filter clause. + Return value: Does not equal + + + + + Represents the caption of the EndsWith filter clause. + Return value: Ends with + + + + + Represents the caption of the Equals filter clause. + Return value: Equals + + + + + Represents the caption of the Greater filter clause. + Return value: Is greater than + + + + + Represents the caption of the GreaterOrEqual filter clause. + Return value: Is greater than or equal to + + + + + Returns “Is in date range”. + + + + + Returns “Is in range”. + + + + + Returns “from”. + + + + + Returns “to”. + + + + + Represents the caption of the IsNotNull filter clause. + Return value: Is not blank + + + + + Returns “Is not blank”. + + + + + Represents the caption of the IsNull filter clause. + Return value: Is blank + + + + + Returns “Is blank”. + + + + + Represents the caption of the Less filter clause. + Return value: Is less than + + + + + Represents the caption of the LessOrEqual filter clause. + Return value: Is less than or equal to + + + + + Represents the caption of the Like filter clause. + Return value: Is like + + + + + Represents the caption of the NoneOf filter clause. + Return value: Is none of + + + + + Represents the caption of the NotBetween filter clause. + Return value: Is not between + + + + + Returns “Is not in date range”. + + + + + Returns “Is not in range”. + + + + + Represents the caption of the NotLike filter clause. + Return value: Is not like + + + + + Specifies an error message that may occur when parsing an expression + Return value: The specified expression contains invalid symbols (line {0}, character {1}). + + + + + Specifies an error message that may occur when parsing an expression + Return value: The specified expression is invalid.. + + + + + Specifies the textual representation of the Between operator used when constructing a display string of filter criteria. + Return value: Between + + + + + Specifies the textual representation of the binary bitwise AND operator used when constructing a display string of filter criteria. + Return value: & + + + + + Specifies the textual representation of the binary bitwise OR operator used when constructing a display string of filter criteria. + Return value: | + + + + + Specifies the textual representation of the binary bitwise XOR operator used when constructing a display string of filter criteria. + Return value: ^ + + + + + Specifies the textual representation of the binary Divide operator used when constructing a display string of filter criteria. + Return value: / + + + + + Specifies the textual representation of the binary Equal to operator used when constructing a display string of filter criteria. + Return value: = + + + + + Specifies the textual representation of the binary Greater than operator used when constructing a display string of filter criteria. + Return value: > + + + + + Specifies the textual representation of the binary Greater than or equal to operator used when constructing a display string of filter criteria. + Return value: >= + + + + + Specifies the textual representation of the binary Less than operator used when constructing a display string of filter criteria. + Return value: < + + + + + Specifies the textual representation of the binary Less than or equal to operator used when constructing a display string of filter criteria. + Return value: <= + + + + + Specifies the textual representation of the binary Like operator used when constructing a display string of filter criteria. + Return value: Like + + + + + Specifies the textual representation of the binary Minus operator used when constructing a display string of filter criteria. + Return value: - + + + + + Specifies the textual representation of the binary Modulo operator used when constructing a display string of filter criteria. + Return value: % + + + + + Specifies the textual representation of the binary Multiply operator used when constructing a display string of filter criteria. + Return value: * + + + + + Specifies the textual representation of the binary Not Equal operator used when constructing a display string of filter criteria. + Return value: <> + + + + + Specifies the textual representation of the binaryPlus operator used when constructing a display string of filter criteria. + Return value: + + + + + + Returns “Abs” + + + + + Returns “Acos” + + + + + Returns “Add days” + + + + + Returns “Add hours” + + + + + Returns “Add milliseconds” + + + + + Returns “Add minutes” + + + + + Returns “Add months” + + + + + Returns “Add seconds” + + + + + Returns “Add ticks” + + + + + Returns “Add time span” + + + + + Returns “Add years” + + + + + Returns “Ascii” + + + + + Returns “Asin” + + + + + Returns “Atn” + + + + + Returns “Atn2” + + + + + Returns “Big Mul” + + + + + Returns “Ceiling” + + + + + Returns “Char” + + + + + Returns “Char index” + + + + + Returns “Concat” + + + + + Returns “Contains”. + + + + + Returns “Cos” + + + + + Returns “Cosh” + + + + + Specifies a string which represents the FunctionOperatorType.Custom function type in filter display text. + Return value: Custom + + + + + Returns “Custom non deterministic” + + + + + Returns “Date diff day” + + + + + Returns “Date diff hour” + + + + + Returns “Date diff millisecond” + + + + + Returns “Date diff minute” + + + + + Returns “Date diff month” + + + + + Returns “Date diff second” + + + + + Returns “Date diff tick” + + + + + Returns “Date diff year” + + + + + Returns “Create date”. + + + + + Returns “Ends with”. + + + + + Returns “Exp” + + + + + Returns “Floor” + + + + + Returns “Get date” + + + + + Returns “Get day” + + + + + Returns “Get day of week” + + + + + Returns “Get day of year” + + + + + Returns “Get hour” + + + + + Returns “Get millisecond” + + + + + Returns “Get minute” + + + + + Returns “Get month” + + + + + Returns “Get second” + + + + + Returns “Get time of day” + + + + + Returns “Get year” + + + + + Specifies the textual representation of the Iif function used when constructing a display string of filter criteria. + Return value: Iif + + + + + Returns “In date range”. + + + + + Returns “In range”. + + + + + Returns “Insert” + + + + + Returns “Is April”. + + + + + Returns “Is August”. + + + + + Returns “Is December”. + + + + + Returns “Is February”. + + + + + Returns “Is January”. + + + + + Returns “Is July”. + + + + + Returns “Is June”. + + + + + Returns “Is last month”. + + + + + Returns “Is last year”. + + + + + Returns “Is March”. + + + + + Returns “Is May”. + + + + + Returns “Is next month”. + + + + + Returns “Is next year”. + + + + + Returns “Is November”. + + + + + Specifies the textual representation of the Is Null function, which takes one or two arguments, used when constructing a display string of filter criteria. + Return value: IsNull + + + + + Returns “Is null or empty” + + + + + Returns “Is October”. + + + + + Specifies the textual representation of the IsBeyondThisYear function, which takes one argument, used when constructing a display string of filter criteria. + Return value: BeyondThisYear + + + + + Specifies the textual representation of the IsEarlierThisMonth function, which takes one argument, used when constructing a display string of filter criteria. + Return value: EarlierThisMonth + + + + + Specifies the textual representation of the IsEarlierThisWeek function, which takes one argument, used when constructing a display string of filter criteria. + Return value: EarlierThisWeek + + + + + Specifies the textual representation of the IsEarlierThisYear function, which takes one argument, used when constructing a display string of filter criteria. + Return value: EarlierThisYear + + + + + Specifies the textual representation of the IsLastWeek function, which takes one argument, used when constructing a display string of filter criteria. + Return value: LastWeek + + + + + Specifies the textual representation of the IsLaterThisMonth function, which takes one argument, used when constructing a display string of filter criteria. + Return value: LaterThisMonth + + + + + Specifies the textual representation of the IsLaterThisWeek function, which takes one argument, used when constructing a display string of filter criteria. + Return value: LaterThisWeek + + + + + Specifies the textual representation of the IsLaterThisYear function, which takes one argument, used when constructing a display string of filter criteria. + Return value: LaterThisYear + + + + + Specifies the textual representation of the IsNextWeek function, which takes one argument, used when constructing a display string of filter criteria. + Return value: NextWeek + + + + + Specifies the textual representation of the IsPriorThisYear function, which takes one argument, used when constructing a display string of filter criteria. + Return value: PriorThisYear + + + + + Specifies the textual representation of the IsToday function, which takes one argument, used when constructing a display string of filter criteria. + Return value: Today + + + + + Specifies the textual representation of the IsTomorrow function, which takes one argument, used when constructing a display string of filter criteria. + Return value: Tomorrow + + + + + Specifies the textual representation of the IsYesterday function, which takes one argument, used when constructing a display string of filter criteria. + Return value: Yesterday + + + + + Returns “Is same day”. + + + + + Returns “Is September”. + + + + + Return value: Is This Month + + + + + Return value: Is This Week + + + + + Return value: Is This Year + + + + + Returns “Is the year-to-date period”. + + + + + Specifies the textual representation of the Len function used when constructing a display string of filter criteria. + Return value: Len + + + + + Specifies the textual representation of the DayAfterTomorrow function, used when constructing a display string of filter criteria. + Return value: DayAfterTomorrow + + + + + Returns “Last month”. + + + + + Specifies the textual representation of the LastWeek function, used when constructing a display string of filter criteria. + Return value: LastWeek + + + + + Returns “Last year”. + + + + + Specifies the textual representation of the NextMonth function, used when constructing a display string of filter criteria. + Return value: NextMonth + + + + + Specifies the textual representation of the NextWeek function, used when constructing a display string of filter criteria. + Return value: NextWeek + + + + + Specifies the textual representation of the NextYear function, used when constructing a display string of filter criteria. + Return value: NextYear + + + + + Specifies the textual representation of the Now function, used when constructing a display string of filter criteria. + Return value: Now + + + + + Specifies the textual representation of the ThisMonth function, used when constructing a display string of filter criteria. + Return value: ThisMonth + + + + + Specifies the textual representation of the ThisWeek function, used when constructing a display string of filter criteria. + Return value: ThisWeek + + + + + Specifies the textual representation of the ThisYear function, used when constructing a display string of filter criteria. + Return value: ThisYear + + + + + Specifies the textual representation of the Today function, used when constructing a display string of filter criteria. + Return value: Today + + + + + Specifies the textual representation of the Tomorrow function, used when constructing a display string of filter criteria. + Return value: Tomorrow + + + + + Returns “Two months away”. + + + + + Specifies the textual representation of the TwoWeeksAway function, used when constructing a display string of filter criteria. + Return value: TwoWeeksAway + + + + + Returns “Two years away”. + + + + + Returns “One year ago”. + + + + + Specifies the textual representation of the Yesterday function, used when constructing a display string of filter criteria. + Return value: Yesterday + + + + + Returns “Log” + + + + + Returns “Log10” + + + + + Specifies the textual representation of the Lower function used when constructing a display string of filter criteria. + Return value: Lower + + + + + Returns “Max” + + + + + Returns “Min” + + + + + Specifies the string which represents the FunctionOperatorType.None function type in filter display text. + Return value: None + + + + + Returns “Not in date range”. + + + + + Return “Not in range”. + + + + + Returns “Now” + + + + + Returns “Pad left” + + + + + Returns “Pad right” + + + + + Returns “Power” + + + + + Returns “Remove” + + + + + Returns “Replace” + + + + + Returns “Reverse” + + + + + Returns “Rnd” + + + + + Returns “Round” + + + + + Returns “Sign” + + + + + Returns “Sin” + + + + + Returns “Sinh” + + + + + Returns “Sqr” + + + + + Returns “Starts with”. + + + + + Specifies the textual representation of the Substring function used when constructing a display string of filter criteria. + Return value: Substring + + + + + Returns “Tan” + + + + + Returns “Tanh” + + + + + Returns “Today” + + + + + Returns “To decimal”. + + + + + Returns “To double”. + + + + + Returns “To float”. + + + + + Returns “To int”. + + + + + Returns “To long”. + + + + + Returns “To str” + + + + + Specifies the textual representation of the Trim function used when constructing a display string of filter criteria. + Return value: Trim + + + + + Specifies the textual representation of the Upper function used when constructing a display string of filter criteria. + Return value: Upper + + + + + Returns “Utc now” + + + + + Specifies the textual representation of the Boolean And operator used when constructing a display string of filter criteria. + Return value: And + + + + + Specifies the textual representation of the Boolean Or operator used when constructing a display string of filter criteria. + Return value: Or + + + + + Specifies the textual representation of the In function used when constructing a display string of filter criteria. + Return value: In + + + + + Specifies the textual representation of the Is not null operator used when constructing a display string of filter criteria. + Return value: Is Not Null + + + + + Specifies the textual representation of the Not like operator used when constructing a display string of filter criteria. + Return value: Not Like + + + + + Specifies the textual representation of the unary bitwise Not operator used when constructing a display string of filter criteria. + Return value: ~ + + + + + Specifies the textual representation of the unary Is null operator used when constructing a display string of filter criteria. + Return value: Is Null + + + + + Specifies the textual representation of the unary Minus operator used when constructing a display string of filter criteria. + Return value: - + + + + + Specifies the textual representation of the unary Not operator used when constructing a display string of filter criteria. + Return value: Not + + + + + Specifies the textual representation of the unary Plus operator used when constructing a display string of filter criteria. + Return value: + + + + + + Returns “Custom functions”. + + + + + Specifies the textual representations of date-time functions shown in filter popup windows. + Return value: “Show all|Filter by a specific date:|Beyond|||Next week|Today|This week|This month|Earlier|{0:yyyy}, {0:MMMM}” + + + + + Specifies the caption of a submenu that contains date-time constants used to filter data + Return value: DateTime constants + + + + + Specifies the caption of a submenu that contains date-time operators used to filter data + Return value: DateTime operators + + + + + Returns “Text” + + + + + Returns “Visual” + + + + + Return value: enter a value + + + + + Returns “Field name”. + + + + + Return value: <enter a parameter> + + + + + Return value: empty + + + + + Returns “Edit Expression…” + + + + + Returns “Functions” + + + + + Return value: And + + + + + Return value: Not And + + + + + Return value: Not Or + + + + + Return value: Or + + + + + Return value: <Add a new parameter …> + + + + + Return value: Clear All + + + + + Return value: Add Condition + + + + + Returns “Add Custom Expression”. + + + + + Return value: Add Group + + + + + Return value: Remove Row + + + + + Returns “Enter a value…”. + + + + + Returns “Enter a parameter name…”. + + + + + Specifies the textual representations of date-time functions shown in filter popup windows. + Return value: + “Show all|Show Empty|Filter by a specific date:|Beyond this year|Later this year|Later this month|Next week|Later this week|Tomorrow|Today|Yesterday|Earlier this week|Last week|Earlier this month|Earlier this year|Prior to this year” + + + + + The text displayed within a tooltip invoked when hovering over the Incremental Search filter popup toolbar button. + Return value: Incremental Search + + + + + The text displayed within a tooltip invoked when hovering over the Invert Filter filter popup toolbar button. + Return value: Invert Filter + + + + + The text displayed within a tooltip invoked when hovering over the Multi-Selection filter popup toolbar button. + Return value: Multi-Selection + + + + + The text displayed within a tooltip invoked when hovering over the Radio Mode filter popup toolbar button. + Return value: Radio Mode + + + + + The text displayed within a tooltip invoked when hovering over the Show New Field Values filter popup toolbar button. + Return value: Show New Field Values + + + + + The text displayed within a tooltip invoked when hovering over the Show Only Available Items filter popup toolbar button. + Return value: Show Only Available Items + + + + + Return value: (Show All) + + + + + Return value: Adds a new item to the list. + + + + + Return value: (Use the Insert or Add button on the keyboard) + + + + + Return value: (Use the Delete or Subtract button on the keyboard) + + + + + Return value: Actions. + + + + + Return value: Adds a new condition to this group. + + + + + Return value: Removes this condition. + + + + + Return value: Compare to a value / other field’s value. + + + + + Returns “Bold Text”. + + + + + Returns “Green Bold Text”. + + + + + Returns “Green Fill”. + + + + + Returns “Green Fill with Green Text”. + + + + + Returns “Green Text”. + + + + + Returns “Italic Text”. + + + + + Returns “Red Bold Text”. + + + + + Returns “Red Fill”. + + + + + Returns “Red Fill with Red Text”. + + + + + Returns “Red Text”. + + + + + Returns “Strikeout Text”. + + + + + Returns “Yellow Fill with Yellow Text”. + + + + + Returns “Format cells that are ABOVE AVERAGE”. + + + + + Returns “Apply formatting to an entire row”. + + + + + Returns “Apply formatting to an entire record”. + + + + + Returns “Format cells that are BELOW AVERAGE”. + + + + + Returns “Format cells that are BETWEEN”. + + + + + Returns “Format cells that rank in the BOTTOM”. + + + + + Returns “Format cells that match the following condition”. + + + + + Returns “Format cell whose values”. + + + + + Returns “Format cells that contain a date matching these conditions”. + + + + + Returns “Format cells that are DUPLICATE VALUES”. + + + + + Returns “Format cells that are EQUAL TO”. + + + + + Returns “<enter an expression>”. + + + + + Returns “for this column with”. + + + + + Returns “for this row with”. + + + + + Returns “Format cells that are GREATER THAN”. + + + + + Returns “Format cells that are LESS THAN”. + + + + + Returns “Above Average”. + + + + + Returns “Below Average”. + + + + + Returns “Between”. + + + + + Returns “Bottom 10 Items”. + + + + + Returns “Bottom 10 %”. + + + + + Returns “Clear Rules from All Columns”. + + + + + Returns “Clear Rules from This Column”. + + + + + Returns “Clear Rules”. + + + + + Returns “Apply a color gradient to a range of\r\ncells in this column. The color indicates\r\nwhere each cell falls within that range.” + + + + + Returns “Color Scales”. + + + + + Returns “Custom Condition”. + + + + + Returns “Add a colored data bar to represent\r\nthe value in a cell. The higher the\r\nvalue, the longer the bar.” + + + + + Returns “Data Bars”. + + + + + Returns “Data Update Rules”. + + + + + Returns “A Date Occurring”. + + + + + Returns “Duplicate Values”. + + + + + Returns “Equal To”. + + + + + Returns “Gradient Fill”. + + + + + Returns “Greater Than”. + + + + + Returns “Highlight Cell Rules”. + + + + + Returns “Use this icon set to classify column\r\nvalues into the following ranges:”. + + + + + Returns “Icon Sets”. + + + + + Returns “Less Than”. + + + + + Returns “Manage Rules…” + + + + + Returns “Solid Fill”. + + + + + Returns “Text that Contains”. + + + + + Returns “Top 10 Items”. + + + + + Returns “Top 10 %”. + + + + + Returns “Top/Bottom Rules”. + + + + + Returns “Unique Values”. + + + + + Returns “Unique/Duplicate Rules”. + + + + + Returns “No Cell Icon”. + + + + + Returns “Format cells that contain the text”. + + + + + Returns “Format cells that rank in the TOP”. + + + + + Returns “Format cells that are UNIQUE VALUES”. + + + + + Returns “with”. + + + + + Identifies the hours item in and controls in a Touch UI. + Return value: hours + + + + + Returns “Directional”. + + + + + Returns “Indicators”. + + + + + Returns “Positive/Negative”. + + + + + Returns “Ratings”. + + + + + Returns “Shapes”. + + + + + Returns “Symbols”. + + + + + Returns “3 Arrows (Colored)”. + + + + + Returns “3 Arrows (Gray)”. + + + + + Returns “4 Arrows (Colored)”. + + + + + Returns “4 Arrows (Gray)”. + + + + + Returns “5 Arrows (Colored)”. + + + + + Returns “5 Arrows (Gray)”. + + + + + Returns “5 Boxes”. + + + + + Returns “3 Flags”. + + + + + Returns “Arrows (Colored)”. + + + + + Returns “Arrows (Gray)”. + + + + + Returns “Triangles”. + + + + + Returns “5 Quarters”. + + + + + Returns “4 Ratings”. + + + + + Returns “5 Ratings”. + + + + + Returns “Red To Black”. + + + + + Returns “3 Signs”. + + + + + Returns “3 Stars”. + + + + + Returns “3 Symbols (Circled)”. + + + + + Returns “3 Symbols (Uncircled)”. + + + + + Returns “3 Traffic Lights (Rimmed)”. + + + + + Returns “3 Traffic Lights (Unrimmed)”. + + + + + Returns “4 Traffic Lights”. + + + + + Returns “3 Triangles”. + + + + + Returns “Image Editor”. + + + + + Specifies the text string displayed within the editor’s edit region when no image is loaded if the RepositoryItemBlobBaseEdit.ShowIcon property is set to false (the identification icon is not displayed). + Return value: (Empty) + + + + + Specifies the text string displayed within the editor’s edit region when the image is loaded if the RepositoryItemBlobBaseEdit.ShowIcon property is set to false (the identification icon is not displayed). + Return value: (Picture) + + + + + Return value: The number must be between 1 and 32767. + + + + + Represents the default error description displayed in a message box/tooltip if the editor’s validation has failed. + Return value: Invalid Value + + + + + Represents the initial value of the LookUpColumnInfo.FieldName property when the object is created without parameters. + Return value: Name + + + + + Specifies the text string displayed in the edit box of the when the edit value is null (Nothing in Visual Basic). + + + + + Reserved for future use. + + + + + Returns “Above Average”. + + + + + Returns “(All)”. + + + + + Returns “Above”. + + + + + Returns “Below”. + + + + + Returns “Equal Or Above”. + + + + + Returns “Equal Or Below”. + + + + + Returns “Format values that are:”. + + + + + Returns “the average of column values”. + + + + + Returns “the average of row values”. + + + + + Returns “Below Average”. + + + + + Returns “Conditional Formatting Rules Manager”. + + + + + Returns “Between”. + + + + + Returns “Equal To”. + + + + + Returns “Greater Than”. + + + + + Returns “Greater Than Or Equal To”. + + + + + Returns “Less Than”. + + + + + Returns “Less Than Or Equal To”. + + + + + Returns “Not Between”. + + + + + Returns “Not Equal To”. + + + + + Returns “Graded Color Scale”. + + + + + Returns “2-Color Scale”. + + + + + Returns “3-Color Scale”. + + + + + Returns “Midpoint”. + + + + + Returns “Automatic”. + + + + + Returns “Color:” + + + + + Returns “Maximum”. + + + + + Returns “Minimum”. + + + + + Returns “Number”. + + + + + Returns “Percent”. + + + + + Returns “Preview:” + + + + + Returns “Type:” + + + + + Returns “Value:” + + + + + Returns “Format Style:” + + + + + Returns “Data Bar”. + + + + + Returns “Axis Color:” + + + + + Returns “Bar Appearance:” + + + + + Returns “Bar Direction:” + + + + + Returns “Border:” + + + + + Returns “Context”. + + + + + Returns “Draw Axis”. + + + + + Returns “Fill:” + + + + + Returns “Gradient Fill”. + + + + + Returns “Left-to-Right”. + + + + + Returns “No Border”. + + + + + Returns “Right-to-Left”. + + + + + Returns “Solid Border”. + + + + + Returns “Solid Fill”. + + + + + Returns “Use Negative Bar”. + + + + + Returns “Data Update”. + + + + + Returns “Following the month in 2 months time”. + + + + + Returns “Following this year”. + + + + + Returns “Prior to the month 6 months ago”. + + + + + Returns “This month, prior to previous week”. + + + + + Returns “This week, prior to yesterday”. + + + + + Returns “This year, prior to this month”. + + + + + Returns “Last Week”. + + + + + Returns “This month, beyond next week”. + + + + + Returns “This week, beyond tomorrow”. + + + + + Returns “This year, beyond this month”. + + + + + Returns “Next Month”. + + + + + Returns “During the month in 2 months time”. + + + + + Returns “Last Month”. + + + + + Returns “During the month 2 months ago”. + + + + + Returns “During the month 3 months ago”. + + + + + Returns “During the month 4 months ago”. + + + + + Returns “During the month 5 months ago”. + + + + + Returns “During the month 6 months ago”. + + + + + Returns “Next Week”. + + + + + Returns “Prior to this year”. + + + + + Returns “This Month”. + + + + + Returns “This Week”. + + + + + Returns “Today”. + + + + + Returns “Tomorrow”. + + + + + Returns “Yesterday”. + + + + + Returns “Delete Rule”. + + + + + Returns “Down”. + + + + + Returns “Edit Rule…” + + + + + Returns “Equal to or Above Average”. + + + + + Returns “Equal to or Below Average”. + + + + + Returns “Background Color:”. + + + + + Returns “Bold”. + + + + + Returns “Format Cells”. + + + + + Returns “Clear”. + + + + + Returns “Effects:”. + + + + + Returns “Fill”. + + + + + Returns “Font”. + + + + + Returns “Font color”. + + + + + Returns “Font Size Delta:”. + + + + + Returns “Font style”. + + + + + Returns “Italic”. + + + + + Returns “None”. + + + + + Returns “Predefined Appearance”. + + + + + Returns “Regular”. + + + + + Returns “Strikethrough”. + + + + + Returns “Underline”. + + + + + Returns “Formula”. + + + + + Returns “Format values where this formula is true:” + + + + + Returns “Apply to the record”. + + + + + Returns “Apply to the row”. + + + + + Returns “Column”. + + + + + Returns “Column Apply To”. + + + + + Returns “Format”. + + + + + Returns “Row”. + + + + + Returns “Row Apply To”. + + + + + Returns “Rule”. + + + + + Returns “Stop If True”. + + + + + Returns “Icon Set”. + + + + + Returns “Icon Set”. + + + + + Returns “Display each icon according to these rules:” + + + + + Returns “Reverse Icon Order”. + + + + + Returns “value is”. + + + + + Returns “When”. + + + + + Returns “ms”. + + + + + Returns “New Rule…” + + + + + Returns “No Format Set”. + + + + + Returns “Bottom”. + + + + + Returns “Format values that rank in the:” + + + + + Returns “% of column values”. + + + + + Returns “% of row values”. + + + + + Returns “Top”. + + + + + Returns “Show formatting rules for:”. + + + + + Returns “Format…” + + + + + Returns “Beginning With”. + + + + + Returns “Containing”. + + + + + Returns “Ending With”. + + + + + Returns “Not Containing”. + + + + + Returns “Blanks”. + + + + + Returns “Cell Value”. + + + + + Returns “Dates Occurring”. + + + + + Returns “Errors”. + + + + + Returns “Format only cells with:” + + + + + Returns “No Blanks”. + + + + + Returns “No Errors”. + + + + + Returns “Specific Text”. + + + + + Returns “Duplicate”. + + + + + Returns “Format all:” + + + + + Returns “Unique”. + + + + + Returns “column values”. + + + + + Returns “row values”. + + + + + Returns “Up”. + + + + + Returns “values for”. + + + + + Specifies the exception message raised when the editor’s entered value specified by the mask is incomplete. + Return value: The entered value is incomplete. Do you want to correct it?\r\n\r\nYes - return to the editor and correct the value.\r\nNo - leave the value as is.\r\nCancel - reset to the previous value.\r\n + + + + + Returns “millisecs”. + + + + + Identifies the minutes item in and controls in a Touch UI . + Return value: mins + + + + + Specifies the default hint of the ‘s button used to insert a new blank record after the last one in the data source. + Return value: Append + + + + + Specifies the default hint of the ‘s button used to cancel edits to the current record. + Return value: Cancel Edit + + + + + Returns “Edit”. + + + + + Specifies the default hint of the ‘s button used to post edited record value to the associated data source. + Return value: End Edit + + + + + Specifies the default hint of the ‘s button used to set the current record to the first record in the dataset. + Return value: First + + + + + Specifies the default hint of the ‘s button used to set the current record to the last record in the data source. + Return value: Last + + + + + Specifies the default hint of the ‘s button used to set the current record to the next record in the data source. + Return value: Last + + + + + Specifies the default hint of the ‘s button used to change the current record position in the data source by the DataNavigatorButtons.PageRecordCount property value upwards. + Return value: Next Page + + + + + Specifies the default hint of the ‘s button used to the current record to the previous one in the data source. + Return value: Previous + + + + + Specifies the default hint of the ‘s button used to change the current record position in the data source by the DataNavigatorButtons.PageRecordCount property value backwards. + Return value: Previous Page + + + + + Specifies the default hint of the ‘s button used to delete the current record. + Return value: Delete + + + + + Specifies the format of the text string which can be displayed in the to display the current record and the total number of records in the associated data source. + Return value: Record {0} of {1} + + + + + Returns “Edit the Rule Description:” + + + + + Returns “Format all cells based on their values”. + + + + + Returns “Format only cells that contain”. + + + + + Returns “Format only changing values”. + + + + + Returns “Format only top or bottom ranked values”. + + + + + Returns “Format only unique or duplicate values”. + + + + + Returns “Format only values that are above or below average”. + + + + + Returns “Select a Rule Type:” + + + + + Returns “Use a formula to determine which cells to format”. + + + + + Returns “New Formatting Rule”. + + + + + Specifies the default hint for the ‘s custom button. + Return value: “” (empty string) + + + + + Returns “(None)”. + + + + + Reserved for future use. + Return value: Not valid array length. + + + + + Returns “Navigation Options”. + + + + + The caption of the Ok button displayed within the dropdown window of a and editors. + Return value: Ok + + + + + An error displayed when an image cannot be copied to the Clipboard by the control. + Return value: Could not copy image + + + + + Applied to image editors ( and are customized to display images). The string represents the caption of the menu item to copy the contents of an editor. + Return value: Copy + + + + + Applied to image editors ( and are customized to display images). The string represents the caption of the menu item to copy and delete the contents of an editor. + Return value: Cut + + + + + Applied to image editors ( and customized to display images).The string represents the caption of the menu item to delete the contents of an editor. + Return value: Delete + + + + + Returns “Edit”. + + + + + Returns “Fit Image”. + + + + + Returns “Full Size”. + + + + + Applied to image editors ( and are customized to display images).The string represents the caption of the menu item to load an image from an external file. + Return value: Load + + + + + Applied to image editors ( and are customized to display images).The string represents the caption of the menu item to replace the contents of an editor with an image from the Clipboard. + Return value: Paste + + + + + Applied to image editors ( and are customized to display images). The string represents the caption of the menu item to save an editor’s image to an external file. + Return value: Save + + + + + Returns “Zoom”. + + + + + Returns “Zoom In”. + + + + + Returns “Zoom Out”. + + + + + Returns “Zoom to:”. + + + + + Returns “{0}%”. + + + + + Specifies the error message displayed when specifying an invalid image for a or editors. + Return value: Wrong picture format + + + + + The caption of the error message displayed when specifying an invalid image for a or . This string is followed by detail information on the error. + Return value: Open error + + + + + Specifies the file masks (filters) for the Open dialog used to load an image from an external file to a or editor. + Return value: Bitmap Files (*.bmp)|*.bmp|Graphics Interchange Format (*.gif)|*.gif|JPEG File Interchange Format (*.jpg;*.jpeg)|*.jpg;*.jpeg|Icon Files (*.ico)|*.ico|Portable Network Graphics Format (*.png)|*.png|Scalable Vector Graphics Format (*.svg)|*.svg|All Picture Files |*.bmp;*.gif;*.jpg;*.jpeg;*.ico;*.png;*.tif;*.svg|All Files |*.* + + + + + The title of the Open File dialog used to load the image into the or editor.. + Return value: Open + + + + + Specifies the file masks (filters) for the Save As dialog used to save the image displayed in a or editor to an external file. + Return value: Bitmap Files (*.bmp)|*.bmp|Graphics Interchange Format (*.gif)|*.gif|JPEG File Interchange Format (*.jpg)|*.jpg|Portable Network Graphics Format (*.png)|*.png|Scalable Vector Graphics Format (*.svg)|*.svg + + + + + The title of the Save File dialog used to save the image displayed in the or editor to an external file. + Return value: Save As + + + + + Return value: Busy + + + + + Return value: Door Open + + + + + Return value: Driver Update Needed + + + + + Return value: Error + + + + + Return value: Initializing + + + + + Return value: IO Active + + + + + Return value: ManualFeed + + + + + Return value: Not Available + + + + + Return value: No Toner + + + + + Return value: Offline + + + + + Return value: Out Of Memory + + + + + Return value: Output Bin Full + + + + + Return value: Page Punt + + + + + The caption of print preview windows. + Return value: Preview: + + + + + Return value: PaperJam + + + + + Return value: PaperOut + + + + + Return value: PaperProblem + + + + + Return value: Paused + + + + + Return value: Pending Deletion + + + + + Return value: Power Save + + + + + Return value: Printing + + + + + Return value: Processing + + + + + Return value: Ready + + + + + Return value: Server Offline + + + + + Return value: Server Unknown + + + + + Return value: Toner Low + + + + + Return value: User Intervention + + + + + This field is obsolete (use DevExpress.XtraPrinting.Localization). + + + + + Return value: Warming Up + + + + + Returns “Cancel”. + + + + + Returns “Cancel pending”. + + + + + Returns “Copying”. + + + + + Returns “Creating document”. + + + + + Returns “Exporting”. + + + + + Returns “Loading data”. + + + + + The ‘s default caption. + Return value: Please Wait + + + + + The ‘s default description. + Return value: Loading … + + + + + Returns “Pasting”. + + + + + Returns “Printing”. + + + + + Returns “XML files (.xml)|.xml|All files|.“. + + + + + Returns “Restore Layout”. + + + + + Returns “XML files (.xml)|.xml”. + + + + + Returns “Save Layout”. + + + + + Specifies the text displayed by the when it is not focused and has no search request. + Return value: Enter text to search… + + + + + Returns “Any”. + + + + + Returns “Search for a column…” + + + + + Returns “Search for a field…” + + + + + Identifies the seconds item in and controls in a Touch UI. + Return value: secs + + + + + Returns “Clear search”. + + + + + Returns “Close”. + + + + + Returns “Toggle to switch between find and replace modes”. + + + + + Returns “Find…”. + + + + + Returns “Find Next”. + + + + + Returns “Find Previous”. + + + + + Returns “Replace…”. + + + + + Returns “Replace All”. + + + + + Returns “Replace”. + + + + + Returns “Show dropdown”. + + + + + Specifies the default hint for the tab control’s Close button. + Return value: Close + + + + + Returns “Scroll Down”. + + + + + Specifies the default hint for the tab control’s Next button which is used to scroll forwards through the tab pages. + Return value: Next + + + + + Returns “Pin”. + + + + + Specifies the default hint for the tab control’s Previous button which is used to scroll backwards through the tab pages. + Return value: Previous + + + + + Returns “Unpin”. + + + + + Returns “Scroll Up”. + + + + + Returns “Show Window List”. + + + + + The caption of the Capture button in the dialog window that takes a picture from a webcam. + Return value: Capture + + + + + The caption of the Save button in the dialog window that saves a picture taken from a webcam. + Return value: Save + + + + + The caption of the dialog window that takes a picture from a webcam. + Return value: Take Picture + + + + + The caption of the Try Again button in the dialog window that takes a picture from a webcam. + Return value: Try Again + + + + + Applied to image editors ( and are customized to display images). The string represents the caption of the menu item that takes an image from a webcam. + Return value: Take Picture from Camera + + + + + Represents the caption of the menu item used to copy the selected contents of an editor. + Return value: Copy + + + + + Represents the caption of the menu item used to cut the selected contents of an editor. + Return value: Cut + + + + + Represents the caption of the menu item used to delete the selected contents of an editor. + Return value: Delete + + + + + Represents the caption of the menu item used to replace the contents of an editor with the text held in the Clipboard. + Return value: Paste + + + + + Represents the caption of the menu item used to select the editor’s content. + Return value: Select All + + + + + Represents the caption of the menu item used to undo the last edit operation in the text box. + Return value: Undo + + + + + Returns “day”. + + + + + Returns “days”. + + + + + Returns “d”. + + + + + Returns “fractional”. + + + + + Returns “fractional”. + + + + + Returns “f”. + + + + + Returns “hour”. + + + + + Returns “hours”. + + + + + Returns “h”. + + + + + Returns “millisecond”. + + + + + Returns “milliseconds”. + + + + + Returns “ms”. + + + + + Returns “minute”. + + + + + Returns “minutes”. + + + + + Returns “m”. + + + + + Returns “second”. + + + + + Returns “seconds”. + + + + + Returns “s”. + + + + + The error message displayed when trying to assign a translucent background color to a control that doesn’t support transparency. + Return value: This control does not support transparent background colors + + + + + Return value: Unknown picture format + + + + + Returns “Version”. + + + + + Represents the caption of the Abort button in the XtraMessageBox. + Return value: Abort + + + + + Represents the caption of the Cancel button in the XtraMessageBox. + Return value: Cancel + + + + + Returns “Do not show this message again”. + + + + + Represents the caption of the Ignore button in the XtraMessageBox. + Return value: Ignore + + + + + Represents the caption of the No button in the XtraMessageBox. + Return value: No + + + + + Represents the caption of the Ok button in the XtraMessageBox. + Return value: Ok + + + + + Represents the caption of the Retry button in the XtraMessageBox. + Return value: Retry + + + + + Represents the caption of the Yes button in the XtraMessageBox. + Return value: Yes + + + + + Contains values that specify how the text case of strings is changed. + + + + + The text case of a string is modified by the control automatically, based on the control’s display mode and other settings. + + + + + All alphabetic characters are in lowercase. + + + + + The first letter of the first word is capitalized. + + + + + If a text string is obtained from the system, it is displayed as is, without text case modifications. + + + + + All alphabetic characters are in uppercase. + + + + + Specifies how a value is displayed and edited in the button editor’s edit box. + + + + + A button editor is displayed in its normal way. However, editing and selecting text is not allowed. If you want to enable a user to select text but disable text modifications, you can set the text editing style to Standard and set the RepositoryItem.ReadOnly property to true. + + + + + + The text editing region is not visible and the editor displays only buttons contained in the current button editor. If no buttons can be displayed (for instance because of setting the EditorButton.Visible property to False), the editor displays an empty region in this case. + + + + + + A button editor works in its normal way. Editing and selecting text is allowed. + + + + + + Contains values specifying the formats of time editor values. + + + + + Hours are displayed within the time editor. + + + + + + Hours and minutes are displayed within the time editor. + + + + + + Hours, minutes and seconds are displayed within the time editor. + + + + + + Lists rules used to determine the first week of the year. + + + + + The rule specified by the System.Globalization.DateTimeFormatInfo.CalendarWeekRule property which defines a calendar week for a specific culture. + + + + + Indicates that the first week of the year starts on the first day of the year and ends before the following designated first day of the week. + + + + + Indicates that the first week of the year is the first week with four or more days before the designated first day of the week. + + + + + Indicates that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year. + + + + + Contains classes that allow custom editors to be embedded in container controls. + + + + + Allows you to embed a , or any custom control into cells of a container control (, , etc.). + + + + + Initializes a new instance of the class. + + + + + Copies settings from the repository item specified as a parameter. + + An object whose settings are to be copied to the current object. + + + + Gets or sets the editor’s border style. + + A value specifying the editor’s border style. + + + + Gets or sets the control displayed by the current object. + + The control displayed by the current object. + + + + Creates an editor whose type corresponds to the repository item’s type. + + A descendant representing the editor whose type corresponds to this repository item’s type. + + + + Gets the class name of the edit control corresponding to the current repository item. + + A System.String object identifying the class name of the corresponding editor. + + + + Returns the text representation of the specified edit value. + + The value whose text representation is to be returned. + The text representation of the specified edit value. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets the editor that owns the repository item. + + The editor that owns the current repository item. + + + + Updates the control that uses the current object. + + + + + Adds registration information on the and a corresponding editor to the default repository. + + + + + Contains data for the BaseListBoxControl.CustomizeItem event. + + + + + Initializes a new instance of the class with the specified settings. + + The owner ListBox control. + The value to initialize the CustomizeTemplatedItemEventArgs.Index property. + The object to initialize the CustomizeTemplatedItemEventArgs.TemplatedItem property. + + + + Gets the current item’s underlying data object. For a bound ListBoxControl, the DataItem property returns the corresponding record in the data source. + + The item’s data object. + + + + Returns the HtmlElement (tag) associated with the current event. + + The HtmlElement (tag) associated with the current event. + + + + Gets the current item’s visual position. For a bound ListBoxControl, this property’s value matches the index of a corresponding record in the data source. + + The item’s zero-based visual position. + + + + Gets the template used to render the current item. Customize this template when handling the BaseListBoxControl.CustomizeItem event. + + The template used to render the current item. + + + + Gets the item’s value. + + The item’s value. + + + + The control that enables navigation through records in a data source and provides common record operations. + + + + + Creates a new object. + + + + + Provides access to the navigator’s built-in and custom buttons. + + A object which is the navigator’s buttons. + + + + Gets or sets the data source member whose data is manipulated by the DataNavigator control. + + A string value representing the data source member. + + + + Gets or sets a data source for the DataNavigator control. + + A data source object whose data is managed by the data navigator. + + + + Gets or sets the position which the data navigator points to in the underlying data source. + + A zero-based integer which specifies a position in the underlying data source. + + + + Occurs after a position in the underlying data source has been changed. + + + + + The DataNavigator‘s button collection. + + + + + Creates a new object. + + A object representing buttons displayed within the DataNavigator control. This value is assigned to the DataNavigator.Buttons property. + + + + Holds settings for buttons displayed in a control. + + + + + Creates a new object. + + An object implementing the INavigatorOwner interface to which the object belongs. This value is assigned to the NavigatorButtonsBase.Owner property. + + + + The button used to insert a new record. + + The navigator’s Append button. + + + + The button used to cancel modifications to the current record. + + The navigator’s Cancel Edit button. + + + + Gets the object which manages a list of binding objects. + + A object used to keep data-bound controls synchronized with each other. + + + + This method supports the .NET framework infrastructure and is not intended to be called in your code. + + + + + The button used to post modifications to the data source. + + The navigator’s End Edit button. + + + + The button that moves the current position to the first record in the data source. + + The navigator’s First button. + + + + The button that moves the current position to the last record in the data source. + + The navigator’s Last button. + + + + The button that moves the current position to the next record. + + The navigator’s Next button. + + + + The button that moves the current position to the next page. + + The navigator’s Next Page button. + + + + Gets or sets the number of records by which the current position moves when a user presses the Previous Page or Next Page button. + + The number of records in a page. + + + + The button that moves the current position to the previous record. + + The navigator’s Previous button. + + + + The button that moves the current position to the previous page. + + The navigator’s Previous Page button. + + + + The button used to delete the current record. + + The navigator’s Remove button. + + + + The base class for controls that allow users to edit date-time values. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets a value which specifies whether the Today button is visible. + + true to show the Today button; otherwise, false. + + + + The editor with a dropdown calendar to display and edit date/time values. + + + + + Initializes a new class instance with default settings. + + + + + Occurs when drawing day cells in the dropdown calendar. + + + + + Gets or sets the date/time value in the control. + + A object representing selected date/time value. + + + + Occurs after the value of the DateEdit.DateTime property has been changed. + + + + + Allows specific dates or date ranges to be disabled in the editor’s drop-down to prevent them from being selected by an end-user. + + + + + Provides the ability to custom paint day cells in the dropdown calendar. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Gets or sets the edit value (current date). + + The current date. + + + + Gets settings specific to the date editor. + + The object containing settings specific to the date editor. + + + + Gets or sets the selected date ranges (DateRange objects). Each DateRange object identifies dates that are EQUAL OR GREATER THAN the DateRange.StartDate and LESS THAN the DateRange.EndDate. Thus the last date is excluded from the range. + + A collection of selected date ranges. + + + + Fires when the selection changes. + + + + + Gets or sets whether changing the DateEdit.DateTime/DateEdit.EditValue property updates the current selection. + + true, if the current selection is automatically set to the edit date (DateEdit.DateTime/DateEdit.EditValue) once the edit date is changed; otherwise false. + + + + Gets or sets the text displayed within the edit box. + + The text displayed in the edit box. + + + + Gets or sets whether the same range of days (as in the current month) is automatically selected in another month when you navigate from the current month to that month. The DateEdit.SyncSelectionWithEditValue property must be set to false to support this feature. + + true if the same range of days is automatically selected in another month when you navigate from the current month to that month; otherwise, false. + + + + The ‘s client that renders a lightweight chart with a date-time horizontal axis. + + + + + Initializes a new instance of the class. + + + + + Provides access to the grid options of the date-time chart range control client. + + A object containing grid options for the date-time chart client of the range control. + + + + Provides access to the range settings of the date-time chart range control client. + + A object that contains settings to customize the range of the date-time chart range control client. + + + + Contains specific settings which define the representation of grid lines and labels in the date-time chart range control client. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the date-time measure unit to which the chart’s gridlines and labels should be aligned. + + A enumeration value that represents the measurement unit to which the chart’s gridlines and labels should be aligned. + + + + Specifies the measurement unit to which selection thumbs of the range control are snapped. + + A enumeration value representing the selection thumbs alignment interval. + + + + Contains the common settings that define the range displayed by a date-time chart client of the range control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the end bound of a date-time chart client range. + + A value that is the range end bound. + + + + Gets or sets the start bound of a date-time chart client range. + + A value that is the range start bound. + + + + Enumerates modes that specify whether to show specific date-time functions in the filter control menus. + + + + + Shows the advanced date-time functions such as Is Same Day, Is Yesterday. + + + + + Advanced if Version Compatibility is set to version 19.1 or newer; otherwise, Standard. + + + + + Do not show date-time functions. + + + + + Shows the standard date-time functions, such as Is Later This Year, Is Next Week. + + + + + The editor that manages values of the System.DateTimeOffset type. + + + + + Initializes a new instance of the class. + + + + + Closes the editor’s drop-down menu and discards all changes a user has made in this menu. To accept changes, call the DateTimeOffsetEdit.ClosePopup() method instead. See the PopupBaseEdit.CancelPopup() method for more information. + + + + + Occurs when the editor drop-down menu is closed. Allows you to identify what caused the menu to close. + + + + + Accepts a user’s edits in the editor drop-down menu and closes this menu. To close the menu without accepting changes, call the DateTimeOffsetEdit.CancelPopup() method instead. See the PopupBaseEdit.ClosePopup() method for more information. + + + + + Fires when the editor drop-down menu is closing and allows you to decide whether changes made by a user should be accepted. See the PopupBaseEdit.CloseUp event for an example. + + + + + Gets or sets the current editor value. + + The current editor value. + + + + Returns the “DateTimeOffsetEdit” string. + + The editor class name. + + + + Gets or sets the current editor value. Use this property to bind an editor to a data source field. To manually set the editor value in code, use the DateTimeOffsetEdit.DateTimeOffset property instead. + + The current editor value. + + + + Allows you to access the editor drop-down menu. Returns nothing if this menu has not yet been opened. See the PopupBaseEdit.GetPopupEditForm() method for more information. + + The editor drop-down menu. + + + + Occurs after the editor shows its drop-down menu. Do not invoke any message boxes within this event handler. + + + + + Provides access to a object that stores core editor settings. + + Stores core editor settings. + + + + Fires when the editor drop-down menu is about to close. Allows you to set the Cancel property to true to keep this menu open. Does not occur when a user clicks outside the editor or switches to another application. See the RepositoryItemPopupBase.QueryCloseUp event for more details. + + + + + Fires when the editor is about to open its drop-down menu. Allows you to set the Cancel property to true to keep this menu closed. See the RepositoryItemPopupBase.QueryPopUp event for more information. + + + + + This is an internal method that should not be called directly in code. + + + + + Attempts to open the editor drop-down menu. The editor first fires the DateTimeOffsetEdit.QueryPopUp event. If the QueryPopUp event was not canceled, the DateTimeOffsetEdit.Popup event occurs and the editor opens its drop-down menu. + + + + + Gets the editor’s display text. Do not modify this property, use the DateTimeOffsetEdit.DateTimeOffset property instead. + + The editor’s display text. + + + + A ‘s client that supports date-time range selection. + + + + + Initializes a new DateTimeRangeControlClient class instance. + + + + + Provides access to a drawing surface. Allows you to draw a label manually. + + + + + Allows you to provide a custom label text. + + + + + Returns the culture settings for month names, day abbreviations, and the first day of the week. + + An object that specifies the culture settings for month names, day abbreviations, and the first day of the week. + + + + Gets or sets culture-specific information about the date-time format of labels. + + An object that contains culture-specific information about the format of date and time values. + + + + Gets or sets a string expression that specifies the date-time format of labels. + + A string expression that specifies the date-time format of labels. + + + + Gets or sets the maximum available value. + + A structure that specifies the maximum available value. + + + + Gets or sets the minimum available value. + + A structure that specifies the minimum available value. + + + + Provides access to a collection of date-time rulers displayed in the client. + + An object that contains date-time rulers. + + + + Contains values that specify whether and how a dropdown arrow is displayed within the control. + + + + + Identical to the DropDownArrowStyle.SplitButton option. + + + + + The dropdown arrow is hidden. + + + + A dropdown control is invoked on clicking the button unless the DropDownButton.ActAsDropDown is set to false. + + + + + The dropdown arrow is merged into the button. + + A dropdown control is invoked on clicking the button unless the DropDownButton.ActAsDropDown is set to false. + + + + + The dropdown arrow is displayed as a separate button. + + + + A dropdown control is invoked on clicking the dropdown arrow button unless the DropDownButton.ActAsDropDown is set to false. + + + + + The button that can be associated with a popup control or a context menu. It is possible to prevent the button from receiving focus on a click. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether a click on the button opens the dropdown control. This option is in effect when the DropDownButton.ShowArrowButton property is set to false. + + true if a click on the button opens the dropdown control; otherwise, false. + + + + Provides access to the appearance settings used to paint the drop-down button. + + An object that specifies the appearance settings used to paint the drop-down button. + + + + Provides access to the appearance settings applied to the drop-down button when the current control is disabled. + + An object that specifies the appearance settings applied to the drop-down button when the current control is disabled. + + + + Provides access to the appearance settings applied to the drop-down button when it is hovered over with the mouse pointer. + + An object that specifies the appearance settings applied to the drop-down button when it is hovered over with the mouse pointer. + + + + Provides access to the appearance settings applied to the drop-down button when it is clicked. + + An object that specifies the appearance settings applied to the drop-down button when it is clicked. + + + + Allows you to respond to clicking the drop-down arrow. + + + + + This member is not supported by the class. + + null. + + + + Gets or sets whether and how a dropdown arrow is displayed within the . + + A enumeration value. + + + + Gets or sets the interior spacing of the separate button displaying the drop-down arrow. This property is in effect if DropDownButton.DropDownArrowStyle is set to SplitButton. + + A representing the interior spacing of the separate button displaying the drop-down arrow. + + + + Gets or sets the popup control for the button. + + A popup control object. + + + + Hides the opened popup control. + + + + + Gets or sets whether the drop-down arrow’s region contains the point with the specified coordinates. + + A structure representing the point to test. + true if the drop-down arrow’s region contains the point with the specified coordinates; otherwise, false. + + + + Gets whether the associated popup control is currently open. + + true if the popup control is open; otherwise, false. + + + + Gets or sets an object that manages the display of the associated popup control . + + An object implementing the IDXMenuManager interface. + + + + Gets or sets whether the drop-down arrow is displayed as a part of the control. + + true if the drop-down arrow is visible; otherwise,false. + + + + Opens the associated popup control. + + + + + Fires when an attempt is made to open the associated popup control. + + + + + Contains classes that support the error handling mechanism. + + + + + Provides error management for DevExpress bound and unbound editors. + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with the specified container. + + An object which implements the interface. + + + + Initializes a new instance of the class with the specified control container. + + A parent of controls whose errors are monitored by the . This value is used to initialize the DXErrorProvider.ContainerControl property. + + + + Sets the data source to be monitored for errors. + + A data set to be monitored for errors. This value is used to initialize the DXErrorProvider.DataSource property. + The name of the specified data set member. This value is used to initialize the DXErrorProvider.DataMember property. + + + + Gets a value indicating whether a control can be extended. + + The control to be extended. + true if the control can be extended; otherwise, false. + + + + Visually clears all error icons that have been displayed by the current . + + + + + Gets or sets a control which owns the controls monitored for errors. + + The that contains the controls monitored for errors by the . + + + + Gets or sets a data source member monitored for errors. + + A string value representing the data source member. + + + + Gets or sets the data source to be monitored for errors. + + An object which represents the data source. + + + + Gets a list of the controls with which errors are associated. + + A list of the controls with which errors are associated. + + + + Gets a list of the controls with which errors of the specified type are associated. + + An value that specifies the type of error that editors to be returned must contain. + A list of the controls with which errors are associated. + + + + Gets an error text associated with the specified control. + + A control whose error text is returned. + A value that represents the error text associated with the specified control. + + + + Allows you to provide custom error icons for editors. + + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + This method supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Gets the type of error associated with the specified control. + + The control whose error type should be obtained. + A value that specifies the error type. + + + + Returns the alignment of the error icon associated with the specified control. + + A control whose error icon alignment is returned. + A value that specifies the alignment of the control’s error icon. + + + + Creates an image from the specified manifest resource. + + The case-sensitive name of the manifest resource being requested. + An SvgBitmap object specifying the required image. + + + + Gets whether there is any error that is set via the ‘s methods or on the data source level. + + true if there is any error; otherwise, false. + + + + Returns whether there is any error of the specified type. + + An value that represents the error type to be located. + true if there is an error of the specified type; otherwise, false. + + + + Updates error information for the specified editor. + + The editor whose error information is to be updated. + + + + Updates error information for all editors managed by the . + + + + + Sets an error icon next to a control. When a user hovers over this icon, a tooltip with an error message appears on-screen. + + A control in which an error occurred. + The error text. + An value that represents the error type, and the type of error icon that will be displayed. + + + + Sets the default error icon next to a control. When a user hovers over this icon, a tooltip with an error message appears on-screen. + + A control where an error occurred. + The error text. + + + + Sets the type of error associated with the specified control. + + The control whose error type is specified. + An value that specifies the error type. + + + + Specifies the alignment of an error icon for a control. + + The control for which the error icon alignment is specified. + A value that specifies the alignment of the control’s error icon. + + + + Gets or sets the ISite for the object. + + The ISite for the object. + + + + Updates the binding and display error information, to reflect errors that could have been set on the data store level. + + + + + Provides data validation management for DevExpress bound and unbound editors. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified container control. + + An object that implements the interface, and owns the created object. + + + + Initializes a new instance of the class with the specified container control. + + A object that owns the created object. + + + + Indicates whether a control can be extended. + + The control to be extended. + true if the control can be extended; otherwise, false. + + + + Retrieves the alignment of an error icon for the specified control. + + A target control. + An value. + + + + Gets the collection of the controls whose values are invalid. + + The collection of the controls whose values are invalid. + + + + Returns a validation rule associated with the specified descendant. + + A descendant. + A DevExpress.XtraEditors.DXErrorProvider.ValidationRuleBase descendant that represents the validation rule associated with the editor. null (Nothing in Visual Basic) if no validation rule is associated with the specified editor. + + + + Gets the collection of the controls whose values are invalid. + + The collection of the controls whose values are invalid. + + + + Removes an error associated with the specified control. + + A control whose error must be removed. + + + + Sets the alignment of an error icon for the specified control. + + A target control. + An value that specifies the alignment to be set for the control. + + + + Associates a validation rule with the specified descendant. + + A descendant that represents the editor. + A DevExpress.XtraEditors.DXErrorProvider.ValidationRuleBase descendant that represents the validation rule. + + + + Validates all the editors associated with the . + + true if all the editors are successfully validated; false if one or more editors are not validated. + + + + Validates the specified editor associated with the . + + A object or descendant that represents the editor to be validated. + true if the editor is successfully validated; otherwise, false. + + + + Gets or sets whether hidden editors are validated when calling the DXValidationProvider.Validate method. + + true if validation of hidden editors is enabled; otherwise, false + + + + Allows you to perform actions when a control’s validation fails. + + + + + Gets or sets the validation mode. + + A DevExpress.XtraEditors.DXErrorProvider.ValidationMode enumeration value that specifies the validation mode. + + + + Occurs after the validation was successfully passed and allows you to perform certain post-validation actions. + + + + + Allows users to build filter criteria and apply them to controls and data sources. + + + + + Initializes a new instance of the class. + + + + + Gets the currently active editor used to edit operand value(s). + + A descendant that represents the currently active editor. null (Nothing in Visual Basic) if no operand value is currently being edited. + + + + Fires when the active editor in the FilterControl is being validated. + + + + + Gets or sets whether filters can be created against properties that are List objects. + + A value that specifies if filters can be created against properties that are List objects. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the Filter Control allows you to display, create, and edit custom expressions—expressions that cannot be converted to Filter Control nodes. + + A value that specifies whether the Filter Control allows you to display, create, and edit custom expressions. + + + + Gets or sets the color used to paint text in the FilterControl when it is disabled. + + The color used to paint text in the disabled FilterControl. + + + + Gets or sets the color of empty values. + + A structure that specifies the color of empty values. + + + + Gets or sets the color of field names. + + A structure that specifies the color of field names. + + + + Gets or sets the color of group operators. + + A structure that specifies the color of group operators. + + + + Gets or sets the color of logical operators. + + A structure that specifies the color of logical operators. + + + + Gets the appearance settings used to paint tree lines. + + A object that provides the appearance settings used to paint tree lines. + + + + Gets or sets the color of values. + + A structure that specifies the color of values. + + + + Applies the filter criteria to the source control. + + + + + Fires before creating an editor used to edit operands in the FilterControl. + + + + + Fires before the Filter Control displays editors for operands. + + + + + Clears the filter criteria. + + + + + Creates empty criteria for the default column (FilterControl.GetDefaultColumn). + + A Node object that specifies the created empty criteria for the default column. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Allows you to assign a custom editor used to display and edit an operand. + + + + + Allows you to specify a custom editor used to edit an operand. Handle the FilterControl.CustomValueEditor event to specify an editor used to display and edit the operand. + + + + + Fires before an editor used to edit operands is disposed of. + + + + + Occurs after filter criteria in the have been modified. + + + + + Gets a filter column collection. + + A DevExpress.XtraEditors.Filtering.FilterColumnCollection object that represents the collection of filter columns. + + + + Gets or sets the total filter expression. + + A descendant that represents the total filter expression. + + + + Gets or sets the total filter expression. + + A value that specifies the total filter expression. + + + + Fires after a value of the FilterControl.FilterString property has been changed. + + + + + Gets the object which contains information used to render the Filter Control. + + A DevExpress.XtraEditors.Filtering.FilterControlViewInfo object. + + + + Gets the default column used to create a new filter in the Filter Control. + + The default filter column. + + + + Allows you to customize a node’s settings when it is initialized. + + + + + Fires after any element (logical operator, operand value, field name, etc.) of the Filter Control has been clicked. + + + + + Fires after any element (logical operator, operand value, field name, etc.) of the Filter Control has been double clicked. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets a value which specifies the width of level indents (horizontal tree lines). + + An integer value that specifies the indent, in pixels. + + + + Gets or sets the maximum number of atomic operands simultaneously displayed within a group operand. If there are more atomic operands in display mode, the group operand’s text representation will be trimmed. In edit mode, the group operand’s values will be edited via a control. This feature is supported when the FilterControl is bound to XtraGrid. + + An integer value that specifies the maximum number of atomic operands simultaneously displayed within a group operand. + + + + Gets or sets the menu manager which controls the look and feel of the context menus. + + An object which implements the DevExpress.Utils.Menu.IDXMenuManager interface. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the distance between logical expressions. + + An integer value which specifies the distance between logical expressions, in pixels. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when any popup menu in a FilterControl is about to be displayed, and allows you to customize these menus. + + + + + Allows you to add custom-function-based filters (for example, ‘discount is more than 15%’) to Excel-style pop-up filter menus and/or the filter editor. + + + + + Gets or sets whether users can edit filter criteria. + + true if users can edit filter criteria; otherwise, false. + + + + Specifies the filter column which is used by default when a new logical expression is created. + + A DevExpress.XtraEditors.Filtering.FilterColumn object or a descendant which represents the filter column used by default when a new logical expression is created. + + + + Creates filter columns. + + A DevExpress.XtraEditors.Filtering.FilterColumnCollection object that represents the collection of filter columns. + An object which represents the menu manager which controls the look and feel of the context menus. + + + + Creates filter columns. + + A DevExpress.XtraEditors.Filtering.FilterColumnCollection object that represents the collection of filter columns. + + + + Gets or sets a value that specifies whether the Filter Control always displays action buttons (for example, add or remove a condition) or displays the buttons on hover. + + A ShowActionButtonMode enumeration value that specifies when the Filter Control displays action buttons. + + + + Gets or sets whether to show custom function-based filters. + + True to show custom function-based filters; False to not show them; Default to enable/disable custom function-based filters depending on the global setting. + + + + Gets or sets whether date-time constants (functions) are available in the second operand’s dropdown field list. Supported when the first operand is a date-time field. + + true if date-time functions/constants are available in the second operand’s field list; otherwise, false + + + + Gets or sets whether to show the standard and advanced date-time functions (BeyondThisYear, LaterThisYear, Tomorrow, Today, Yesterday, LastWeek, etc.) for date-time fields. + + A DateTimeFunctionsShowMode enumaration value that specifies whether to show the standard and advanced date-time functions for date-time fields. + + + + Gets or sets whether date-time specific operators are available for date-time fields. + + true if date-time specific operators are available for date-time fields; otherwise, false + + + + Allows the FilterControl’s context menus to be customized. + + + + + Gets or sets whether the group commands icon is displayed. + + true to display the group commands icon; otherwise, false. + + + + Gets or sets whether the IsNull operator is available for string values. + + true if the IsNull operator is available for string values; otherwise, false. + + + + Gets or sets whether date-time functions/constants are available in the second operand’s value box for date-time fields. + + true if date-time functions/constants are available in an operand value box for date-time fields; otherwise, false. + + + + Gets or sets whether a user can swap the second operand’s type (between the Value box and Field list). The Field list allows users to compare the first operand (field) with another field. + + true, to allow end-users to swap the second operand’s type; otherwise, false. + + + + Gets or sets whether column captions appear sorted in the ‘s menus. + + true to sort column captions; otherwise, false. + + + + Gets or sets the control/data source to which the FilterControl provides filter criteria. + + An object that represents the source control for the Filter Control. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + null (Nothing in Visual Basic) + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether a menu or combobox editor is used to select operands and operators in a . + + true if a menu is used to select operands and operators in a ; false if a combobox editor is used. + + + + Fires after an operand’s editor has been displayed. + + + + + Contains values that specify how a Filter Editor Control’s criteria can be edited. + + + + + The Filter Editor’s filter can be solely edited in text form, using a dedicated text editor. + + + + + A Filter Editor displays two pages: Text and Visual, allowing an end-user to build filters in text and visual forms respectively. + + + + + The Filter Editor’s filter can be solely edited in a visual form, using a dedicated tree view. + + + + + A Filter Editor displays two pages: Visual and Text, allowing an end-user to build filters in visual and text forms respectively. + + + + + Contains classes that implement a filtering functionality for DevExpress Windows Forms controls. + + + + + Initializes a new instance of the class. + + + + + Provides access to the object, which allows you to customize the ‘s “Text” tab. + + An object that allows you to customize the ‘s “Text” tab. + + + + Gets the FilterControl (in Visual view mode) or embedded FilterControl (in VisualText, TextVisual and Text view modes). + + The FilterControl or embedded FilterControl. + + + + Provides access to the currently used Filter Control (FilterControl or FilterEditorControl) via an interface. + + The Filter Control (as an IFilterControl object). + + + + Gets or sets whether to display the Filter Editor (the form that embeds the Filter Editor). + + true, to display the Filter Editor; otherwise, false. + + + + Initializes a new instance of the class with specified settings. + + + + + Serves as a base class for classes providing data for events that allow you to customize filter conditions in the Excel-style filter dropdowns. + + + + + Adds the specified data value by which the column being processed can be filtered, and the corresponding text to be displayed in the filter popup. + + The data value by which the column can be filtered. + The text of the filter condition to be displayed in the filter popup. + true, to enable HTML formatting for the text parameter; otherwise, false. + An ExcelFilterDataItem object specifying the filter item. + + + + Adds the specified filter condition by which the column being processed can be filtered, and the corresponding text to be displayed in the filter popup. + + The display text for the filter condition. + The filter condition. + true, to enable HTML formatting for the text parameter; otherwise, false. + An ExcelFilterItem object specifying the filter item. + + + + Adds the specified filter condition by which the column being processed can be filtered, and the corresponding text to be displayed in the filter popup. + + The display text for the filter condition. + The filter condition. + true, to enable HTML formatting for the text parameter; otherwise, false. + An ExcelFilterItem object specifying the filter item. + + + + Changes the display text in the filter popup for the specified data value. + + The data value for which to change the display text. + The text to be displayed in the filter popup for the specified data value. + true if the display text is successfully changed; otherwise, false. + + + + Removes all items from the collection of data values by which the column being processed can be filtered. + + true if the items are successfully removed; otherwise, false. + + + + Provides access to the collection of data values by which the column being processed can be filtered, and the corresponding display texts. + + An object that specifies the collection of data values by which the column being processed can be filtered. + + + + Provides acces to the collection of the texts to be displayed in the filter popup for the corresponding data values by which the column being processed can be filtered. + + A [] object specifying the collection of the display texts. + + + + Provides access to the collection of custom filter conditions by which the column being processed can be filtered. + + A <DevExpress.XtraEditors.Filtering.ExcelFilterItem,> object specifying the collection of custom filter conditions by which the column being processed can be filtered. + + + + Returns an array of strings representing captions for filters in the popup. + + An array of strings representing captions for filters in the popup. + + + + Returns the collection of custom filter conditions by which the column being processed can be filtered. + + The collection of custom filter conditions by which the column being processed can be filtered. + + + + Returns an array of objects representing data values by which the column being processed can be filtered. + + An array of objects representing data values by which the column being processed can be filtered. + + + + Gets or sets a collection of images to be inserted into filter item captions using HTML tags. This property is in effect when the HTML formatting feature is enabled for filter item captions. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Gets or sets the alignment of images fetched from the column’s image combo box editor to the filter menu. For internal use. + + A enumeration value that specifies the image alignment. + + + + Provides access to the collection of images fetched form the column’s image combo box editor to the filter menu. For internal use. + + An object specifying the image collection. + + + + Gets whether these event arguments contain data values. + + true if these event arguments contain data values; otherwise, false. + + + + Gets or sets whether the data is not yet loaded during asynchronous data loading. + + true if the data is not yet loaded; otherwise, false. + + + + Event arguments used when actual data is not yet loaded asynchronously. + + + + + Removes the specified data value by which the column being processed can be filtered from the filter popup. + + The data value to remove from the filter popup. + true if the specified data value is successfully removed from the filter popup; otherwise, false. + + + + Provides access to the collection of data values by which the column being processed can be filtered. + + An [] specifying the collection of data values by which the column being processed can be filtered. + + + + Provides data for events that allow you to customize filter conditions in the Excel-style filter dropdowns. + + + + + Gets the column being processed. + + The column being processed. + + + + Enumerates available menu types. + + + + + Not supported. + + + + + The menu to choose operators in aggregate nodes (represent collection properties). This menu is available when you edit a collection property and the FilterControl.AllowAggregateEditing property is set to Aggregate or AggregateWithCondition. + + + + + + The menu to choose a field in field-based operators in aggregate nodes (represent collection properties). This menu is available when you edit a collection property and the FilterControl.AllowAggregateEditing property is set to Aggregate or AggregateWithCondition + + + + + + The menu to choose the operation type. + + + + + + The menu to choose the field (column) name. + + + + + + The menu that displays comparison fields (columns) and date-time constants. This menu is available when FilterControl.ShowOperandTypeIcon is set to true. The FilterControl.ShowDateTimeConstants property specifies the availability of the date-time constants in the menu. + + + + + + The menu to choose group operations. + + + + + + The menu to manage conditions (available when the FilterControl.ShowGroupCommandsIcon option is enabled). + + + + + + Provides data for the FilterControl.InitNode event. + + + + + Initializes a new instance of the class. + + The property name. + The property type. + true, if the node is new; otherwise, false. + + + + Gets whether the node is newly created. + + true, if the node is newly created; false, if the node already existed. + + + + Gets or sets the property (field) name. + + The property (field) name. + + + + Sets the operation type for the current node. + + The operation type. + + + + Sets the operation type for the current node. + + The operation type. + + + + Applies a registered custom function to the current node. + + The name of the registered custom function. + + + + Provides data for the FilterControl.PopupMenuShowing event. + + + + + Initializes a new instance of the class. + + The current node. + A value that identifies the type of the Filter Control’s element where the menu is to be displayed. + The type of the FilterControl’s menu to be invoked. + The menu to be invoked + The position where the menu is to be invoked. + + + + Gets the node where the menu is to be displayed. + + A Node object that identifies the clicked node. + + + + Gets the type of the Filter Control’s element where the menu is to be displayed. + + An ElementType enumeration value that identifies the type of the Filter Control’s element where the menu is to be displayed. + + + + Gets the menu that will be invoked. + + A object that is the menu to be invoked. + + + + Gets the type of the FilterControl’s menu to be invoked. + + A FilterControlMenuType enumeration value that specifies the type of the FilterControl’s menu to be invoked. + + + + Gets the position where the menu is to be invoked. + + A Point value that specifies the position where the menu is to be invoked. + + + + Gets or sets whether the current menu should be restored to its default state, after it has been displayed on-screen. + + A Boolean value that specifies whether the current menu should be restored to its default state after it has been displayed on-screen. + + + + Represents a method that will handle the FilterControl.PopupMenuShowing event. + + The event source. This parameter identifies the which raised the event. + A object which contains event data. + + + + Provides data for the FilterControl.BeforeShowValueEditor event. + + + + + Initializes a new instance of the class with the specified settings. + + An editor that is about to be invoked. This value is assigned to the object’s Editor property. + An object that identifies the current node in the FilterControl’s tree. This value is assigned to the ShowValueEditorEventArgs.CurrentNode property. + A DevExpress.Data.Filtering.OperandValue object that is the current value. This value is assigned to the ShowValueEditorEventArgs.OperandValue property. + The index of an operand value. This value is assigned to the ShowValueEditorEventArgs.FocusedElementIndex property. + + + + Gets the current node in the FilterControl’s tree of criteria. + + A ClauseNode object that is the current node. + + + + Allows you to specify a custom editor to be opened instead of the default one, specified by the Editor property. + + A descendant identifying the custom editor that will be created and displayed instead of the default one. + + + + Gets the index of the current operand value. + + An integer that specifies the index of the current operand value. + + + + Gets the current operand value. + + An object that specifies the current operand value. + + + + Gets the operation of the current node. + + A ClauseType value that specifies the current operation. + + + + The base class for objects that provide data for editor specific events. + + + + + Gets the currently processed editor. + + A descendant that represents the currently processed editor. + + + + The editor to select a font from a dropdown list. + + + + + Initializes a new instance of the class. + + + + + Closes the popup window accepting the changes made. + + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + Gets an object which contains properties, methods and events specific to the control. + + A object that contains a control’s settings. + + + + Gets or sets the index of the selected item. + + An integer value that specifies the index of the selected item. + + + + Enumerates the comparison operators (Equal, Between, Less, etc.). + + + + + The format is applied to cells (or rows) whose values are between the and property values inclusive. Disable the option to make the condition exclusive. + + + + + The format is applied to cells (or corresponding rows) whose values match the FormatConditionRuleValue.Value1 property value. + + + + + The format is applied to cells (or corresponding rows) if the FormatConditionRuleValue.Expression evaluates to true. + + + + + The format is applied to cells (or corresponding rows) whose values are greater than the FormatConditionRuleValue.Value1 property value. + + + + + The format is applied to cells (or corresponding rows) whose values are greater or equal to the FormatConditionRuleValue.Value1 property value. + + + + + The format is applied to cells (or corresponding rows) whose values are less than the FormatConditionRuleValue.Value1 property value. + + + + + The format is applied to cells (or corresponding rows) whose values are less or equal to the FormatConditionRuleValue.Value1 property value. + + + + + The format is applied to all cells in the target column. + + + + + The format is applied to cells (or rows) whose values are not between the and property values inclusive. Disable the option to make the condition exclusive. + + + + + The format is applied to cells (or corresponding rows) whose values do not match the FormatConditionRuleValue.Value1 property value. + + + + + Enumerates value ranges relative to an average value. + + + + + The range that includes values above the average value. + + + + + The range that includes values below the average value. + + + + + The range that includes values that are above or equal to the average value. + + + + + The range that includes values that are below or equal to the average value. + + + + + Contains values that specify how the range’s maximum and minimum values are calculated when the FormatConditionRuleMinMaxBase.MaximumType and FormatConditionRuleMinMaxBase.MinimumType properties are set to Automatic. + + + + + Default is equivalent to ValueBased mode. + + + + + The range’s maximum and minimum values are the highest and lowest column values, respectively. + + + + + The range’s maximum value is the highest column value, but not less than 0. + The range’s minimum value is the lowest column value, but not greater than 0. + + + + + Serves as a base for collections of style conditions. + + + + + Initializes a new instance of the class. + + + + + Appends the specified style format condition to the collection. + + A object or descendant to be added to the collection. + + + + Copies the settings from the object passed as the parameter. + + A object or descendant which represents the source of the operation. + + + + Locks the by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called. + + + + + Occurs when the collection is changed. + + + + + When overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one is less than, equal to or greater than the other. + + The first object to compare. + The second object to compare. + An integer value indicating whether one is less than, equal to or greater than the other. + + + + Indicates whether the current collection contains the specified style format condition. + + A object or descendant which represents the style format condition to locate in the collection. + true if the collection contains the specified style format condition; otherwise, false. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Returns the specified condition’s position within the collection. + + A object or descendant to locate in the collection. + A zero-based integer which represents the condition’s position within the collection. -1 if the condition doesn’t belong to the collection. + + + + When overridden by descendant classes, indicates whether the control that owns the current collection is currently being initialized. + + true if the control is being initialized; otherwise, false. + + + + Provides indexed access to individual items within the collection. + + An integer value specifying the item’s zero based index within the collection. If its negative or exceeds the last available index, an exception is raised. + A object or descendant which resides at the specified position within the collection. + + + + Gets a style format condition with the specified tag. + + An object which contains information associated with the style format condition. + A object or descendant which represents a style format condition within the collection whose StyleFormatConditionBase.Tag property’s value matches the tag parameter. null (Nothing in Visual Basic) if no style format condition is found. + + + + Gets an item from the collection by its name. + + A string value specifying the name of the desired item. + A object with the required name. null (Nothing in Visual Basic) if there are no items with the specified name in the collection. + + + + Removes the specified object from the collection. + + A object to remove. + + + + Enumerates comparison operators used to set the FormatConditionIconSetIcon.ValueComparison property. + + + + + The Greater Than operator. + + + + + The Greater Than or Equal To operator. + + + + + Enumerates triggers for the FormatConditionRuleDataUpdate format. + + + + + Allows you to implement a custom trigger for the format rule by handling the GridView.FormatRuleDataUpdateCustomTrigger event. End-users are not able to access and modify custom triggers at runtime (in the Conditional Formatting Rules Manager). + + + + + Activates a format when a value changes. + + + + + Activates a format when a value decreases. + + + + + Activates a format when a value increases. + + + + + A class that exposes an icon set for the format. + + + + + Initializes a new instance of a class. + + + + + Gets or sets the category name of the current icon set. + + A value that specifies the category name of the current icon set. + + + + Gets whether the current icon set contains icons. + + true, if the current icon set contains one or more icons; otherwise; false. + + + + Specifies an icon collection for the format. + + An icon collection. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the name of the current icon set. + + A value that specifies the name of the current icon set. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A string that specifies the icon set’s range description. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns the text representation of the current icon set. + + A value that specify the text representation of the current icon set. + + + + Gets or sets the type of threshold values for the current icon set. + + A value that specifies the type of threshold values for the icon set. + + + + A single icon, which corresponds to a specific range in the format. + + + + + Initializes a new instance of a class. + + + + + Returns the text representation of the current object. + + A string value that specifies the text representation of the current object. + + + + Gets or sets a threshold value that defines the range to which the current icon corresponds. + + A value that specifies a threshold of the target value range. + + + + Gets or sets the comparison operator used to define the target range corresponding to the current object. + + A value that specifies the comparison operator. + + + + Applies a format using a two-color scale to display data distribution and variation. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or sets the color corresponding to the maximum threshold. + + A value that specifies the color corresponding to the maximum threshold. + + + + Gets or sets the color corresponding to the minimum threshold. + + A value that specifies the color corresponding to the minimum threshold. + + + + Gets or sets the name of the predefined color scale for the current conditional formatting rule. + + The name of the predefined color scale for the current conditional formatting rule. + + + + Applies a format using a three-color scale to display data distribution and variation. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or sets a value that specifies the midpoint of the target value range. + + A value that specifies the midpoint of target the range. + + + + Gets or sets the color corresponding to the midpoint of the target value range. + + The color corresponding to the midpoint of the target value range. + + + + Gets or sets the type of the midpoint of the target range. + + The type of the midpoint of the target range. + + + + Applies a format if a cell value is above or below the column’s average. + + + + + Initializes a new instance of a class. + + + + + Gets or sets the target range relative to a column’s average value. + + The target range relative to a column’s average value. + + + + Creates a new instance of the class. + + A new object. + + + + The base class for style formats that allow cells to be customized using the FormatConditionRuleAppearanceBase.Appearance property. + + + + + Initializes a new instance of a class. + + + + + Allows you to explicitly set the appearance settings (background and foreground colors and font settings) for target cells. This property’s settings take priority over the style specified by the FormatConditionRuleAppearanceBase.PredefinedName property. + + An object that specifies appearance settings applied to target cells. + + + + Gets or sets the name of a predefined or custom style applied to target cells. + + A string that specifies the name of a predefined style. + + + + The base class for classes that implement conditional formatting rules. + + + + + Gets or sets whether the format is repainted with an animation effect when a cell value changes. Animation effects are supported for specific format rules, only in Data Grid’s , and . + + A value that specifies whether an animation effect is enabled for the format rule. + + + + Copies settings from the specified object to the current object. + + An object whose settings are to be copied to the current object. + + + + Locks the by preventing change notifications from being fired, preventing visual updates until the EndUpdate method is called. + + + + + Gets or sets whether the condition is inclusive (the and property values are included in the interval). + + or if the condition is inclusive; otherwise, . + + + + Converts the specified object to the nullable decimal type. + + The object to be converted to the nullable decimal type. + The result of the conversion. + + + + This method is overridden by descendants to create new class instances. + + A new instance of a descendant. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets whether an animation effect is enabled for and supported by the format rule. + + true if an animation effect is enabled for and supported by the format rule + + + + For internal use. + + + + + Returns whether the current rule evaluates to “true” for input values provided by the specified valueProvider. + + An object that provides values to test against the current rule. + true if the current rule is true; otherwise, false. + + + + Gets whether the current object is properly customized. + + true if the object is properly customized; otherwise, false. + + + + Returns the text representation of the current object. + + The text representation of the current object. + + + + Enumerates values indicating how the rule has been changed. + + + + + Data and UI settings have been updated. + + + + + Data has been updated. + + + + + No changes. + + + + + UI settings have been updated. + + + + + Applies a format if a value matches one of the specified values. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new object. + + + + Gets or sets a list of constants. + + An object that specifies a list of constants for the formatting rule. + + + + Applies a format using a data bar. + + + + + Initializes a new instance of a class. + + + + + Gets or sets whether negative data bars are displayed in the direction opposite to the positive data bars. + + true if negative data bars are displayed in the direction opposite to the positive data bars; otherwise, false. + + + + Provides access to appearance settings for data bars that correspond to positive cell values. + + An object that specifies appearance settings for positive data bars. + + + + Provides access to appearance settings for data bars that correspond to negative cell values. + + An object that specifies appearance settings for negative data bars. + + + + Gets or sets the color of the vertical axis between positive and negative data bars. + + A value that specifies the color of the vertical axis between positive and negative data bars. + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or set whether to draw the vertical axis between positive and negative data bars. + + true if the axis is painted; otherwise, false. + + + + Gets or sets whether to draw the vertical axis between positive and negative bars at the middle of the cell. + + true, to draw the axis at the middle of the cel; false, to draw the axis at the position specified by the proportion of the minimum negative value to the maximum positive value. + + + + Gets or sets the name of the predefined bar style. + + A string value that specifies the predefined style name. + + + + Gets or sets whether to display positive data bars in the right-to-left direction. + + A value that specifies whether to display data bars in the right-to-left direction. + + + + Gets or sets whether to display data bars within target cells without cell values. + + true, if data bars are displayed within cells without cell values; false, if data bars are displayed along with cell values. + + + + Highlights a cell with a custom icon and/or appearance settings for a limited time when a cell value changes. This format is only supported in Data Grid’s , and . + + + + + Initializes a new instance of the class. + + + + + Creates a new instance of the current class. + + The created instance of the current class. + + + + Gets or sets the time during which the format is applied. + + The delay in milliseconds after which the format is cleared. + + + + Allows you to display a custom image or a predefined icon. + + An object that specifies an icon or image for the format. + + + + Gets or sets when to activate the format. + + A value that specifies when to activate the format. + + + + Applies a format if a column’s DateTime value refers to a specific date and/or date interval relative to today. These days and intervals include Today, Yesterday, This week, Earlier this month, Prior to this year, etc. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new object. + + + + Gets or sets the filter that identifies a target date or dates. + + The filter that identifies a target date or dates. + + + + Reapplies the conditional formatting rule, taking into account the current date. + + + + + Applies a format if cell values meet a specific expression. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new object. + + + + Gets or sets a Boolean expression. When the expression evaluates to true, a format is applied to cells. + + A string that specifies the Boolean expression. + + + + For internal use. + + + + + Applies a format using an icon set. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or sets an icon set. + + A value that specifies an icon set. + + + + Gets whether the current icon set is properly customized. + + true if the current icon set is properly customized; otherwise, false. + + + + A base class for classes that implement conditional formatting rules based on minimum and maximum thresholds. + + + + + Initializes a new instance of a class. + + + + + Gets or sets how the range’s maximum and minimum values are calculated when the FormatConditionRuleMinMaxBase.MaximumType and FormatConditionRuleMinMaxBase.MinimumType properties are set to Automatic. + + A value that specifies how the range’s maximum and minimum values are calculated in Automatic mode. +The FormatConditionAutomaticType.Default value is equivalent to FormatConditionAutomaticType.ValueBased. + + + + Creates a new instance of the class. + + A new instance. + + + + Returns the actual value of the FormatConditionRuleMinMaxBase.AutomaticType setting. + + The actual value of the FormatConditionRuleMinMaxBase.AutomaticType setting. + + + + Gets or sets the maximum of the target value range. + + The maximum of the target value range. + + + + Gets or sets whether the target range’s maximum is automatically calculated or specified manually (as a number or percentage). + + A value that specifies how the maximum of the target range is defined. + + + + Gets or sets the minimum of the target value range. + + The minimum of the target value range. + + + + Gets or sets whether the target range minimum is automatically calculated or specified manually (as a number or percentage). + + A value that specifies how the minimum of the target range is defined. + + + + Applies a format if a value is in the range of the highest or lowest column values. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or sets a cutoff value that specifies the count or percentage of column cells with the highest or lowest values. + + An object that specifies a count or percentage of cells with the highest or lowest values. + + + + Gets or sets the type of the FormatConditionRuleTopBottom.Rank value. + + An object that specifies a type of the rank value. + + + + Gets or sets whether the rule targets the highest or lowest column values. + + An object that specifies the type of the target range. + + + + Applies a format if a column’s value is unique or a duplicate. + + + + + Initializes a new instance of a class. + + + + + Creates a new instance of the class. + + A new instance. + + + + Gets or sets whether the format is applied to unique or duplicate column values. + + A value that specifies whether the format is applied to unique or duplicate column values. + + + + Applies a format if a column’s value meets a specified condition (Equal, Less, Between, etc.). + + + + + Initializes a new instance of a class. + + + + + Gets or sets the comparison operator (Equal, Between, Less, etc.). + + The comparison operator. + + + + Creates a new instance of the class. + + A new object. + + + + Gets or sets a Boolean expression to which target cells should match. + + A string that specifies the Boolean expression. + + + + Gets or sets the first constant that is compared with column values. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A value that is compared with column values. + + + + Gets or sets the second constant that is compared with column values. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A value that is compared with the column’s values. + + + + Enumerates value ranges relative to a certain value. + + + + + The lowest values. + + + + + The highest values. + + + + + Identifies values as unique or duplicate. + + + + + Duplicate column values. + + + + + Unique column values. + + + + + Enumerates how cutoff/minimum/maximum values are regarded and whether they are calculated automatically. + + + + + A cuttoff/minimum/maximum value is calculated automatically. + + + + + + + + Cell values are compared with zero. + + + + + Cell values are compared with each other. The minimum cell value is treated as 0%, the maximum value is 100%. + + + + + The base class for objects that apply style formats to controls. + + + + + Initializes a new instance of the class. + + + + + Copies settings from the specified object to the current object. + + An object whose settings are copied to the current object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The field name of the column that provides values to test against the current formatting rule. + + + + Gets or sets whether the current object is enabled. + + true if the current object is enabled; otherwise, false. + + + + Returns whether the current rule (FormatRuleBase.Rule) evaluates to “true” for input values provided by the specified valueProvider. + + An object that provides values to test against the current rule. + true if the current rule is true; otherwise, false. + + + + Gets whether the current object is properly customized. + + true if the object is properly customized; otherwise, false. + + + + Gets or sets the name of the current object. + + The object’s name. + + + + Gets or sets the style format rule, which defines the condition and appearance settings applied when the condition is true. + + The style format rule. + + + + Returns the FormatRuleBase.Rule object type-cast to the specified type. + + The FormatRuleBase.Rule object type-cast to the specified type. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether subsequent format rules that target a specific cell should be ignored if the current format rule evaluates to true for this cell. + + true if subsequent format rules that target a specific cell should be ignored if the current format rule evaluates to true for this cell; otherwise, false. + + + + Gets or sets custom data associated with the current object. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + Custom data associated with the current object. + + + + Returns the text representation of the current object. + + The text representation of the current object. + + + + A collection of objects that specify rules used to apply conditional formatting in data-aware controls. + + An object that specifies a format rule. + An object that specifies the column (row in a vertical grid) that contains values to be formatted. + + + + Applies a format based on the specified condition and associates it with the specified column (row in a vertical grid). + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + A descendant. + A {T} object that specifies a format. + + + + Applies a format that uses a range of colors to illustrate data distribution. You can specify the minimum and maximum values and colors for them. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The color that corresponds to the minimum threshold. This value is assigned to the property. + The color that corresponds to the maximum threshold. This value is assigned to the property. + A value that specifies whether the minimum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the property. + A value that specifies whether the maximum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the property. + The minimum value of the target range. This value is assigned to the property. + The maximum value of the target range. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format that uses a range of colors to illustrate data distribution. You can specify the minimum, maximum, and midpoint values, and colors for them. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The color that corresponds to the minimum threshold. This value is assigned to the property. + The color that corresponds to the midpoint of the target value range. This value is assigned to the property. + The color that corresponds to the maximum threshold. This value is assigned to the property. + A value that specifies whether the minimum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the property. + A value that specifies whether the midpoint value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the property. + A value that specifies whether the maximum value is automatically calculated or specified manually (as a number or percentage). This value is assigned to the property. + The minimum value of the target range. This value is assigned to the property. + The midpoint of the target value range. This value is assigned to the property. + The maximum value of the target range. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to values above average. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings applied to values above average. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to values above or below average. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings applied to values above average. This value is assigned to the property. + The target range (above or below). This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format based on the specified rule and appearance settings. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + An object that specifies a rule. + The appearance settings applied to the column (row in a vertical grid). This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to values below average. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings applied to values below average. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to cells with lowest values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + The number (as an absolute value or a percentage) of cells that should be formatted. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format that displays bars that illustrate cell values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + A {T} object that specifies a format. + + + + This method is obsolete (use AddDateOccurringRule). + + + + + Applies a format to cells that contain specific dates. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The date to which the format should be applied. This value is assigned to the property. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to duplicate values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to cells that match a criterion expression. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + The expression that specifies a criterion. + A {T} object that specifies a format. + + + + Applies a format that displays icons in cells. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The icons. This value is assigned to the property. + A {T} object that specifies a format. + + + + Adds a rule to the collection. + + The rule that should be added to the collection. + + + + Applies a format to cells with highest or lowest values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + A value that specifies the target range (highest or lowest). This value is assigned to the property. + The number (as an absolute value or a percentage) of cells that should be formatted. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to cells with highest values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + The number (as an absolute value or a percentage) of cells that should be formatted. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to unique or duplicate values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + A value that specifies whether the format is applied to unique or duplicate values. This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to unique values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + A {T} object that specifies a format. + + + + Applies a format to cells that contain specific values. + + A {TColumnType} object that specifies a column (row in a vertical grid) to which the format should be applied. + The appearance settings that should be applied to the column (row in a vertical grid). This value is assigned to the property. + The comparison operator (Equal, Between, Less, and so on). This value is assigned to the property. + The first constant that is compared with column (row in vertical grid) values. This value is assigned to the property. + The second constant that is compared with column (row in vertical grid) values. This value is assigned to the property. + A {T} object that specifies a format. + + + + Locks the event until the method is called. + + + + + Fires when the collection changes. + + + + + Unlocks the event after a method call. + + + + + Returns a rule at the specified position in the collection. + + A value that specifies a position in the collection. + An object that specifies a rule. + + + + Determines whether the collection contains objects. For internal use. + + true if the collection contains objects; otherwise, false. + + + + Determines whether the collection contains rules that can be applied. For internal use. + + true if the collection contains rules that can be applied; otherwise, false. + + + + Returns the zero-based index of the specified rule in the collection. + + An object to locate in the collection. + An integer value that specifies the position of the rule in the collection. + + + + Determines whether the collection is locked. + + true if the collection is locked; otherwise, false. + + + + Returns a rule at the specified position in the collection. + + A value that specifies a position in the collection. + A {T} object that specifies a rule. + + + + Returns a rule by its name. + + A string value that specifies a rule’s name. A rule’s property specifies the name. + A {T} object that specifies a rule. + + + + Returns a string that describes the current object. + + A string that describes the current object. + + + + Enumerates painting styles for selected and hot-tracked items in list box and pop up controls. + + + + + The same as the Skinned option. + + + + + Selected and hot-tracked items are painted skinned if a skinning painting scheme is applied. Otherwise, items are not skinned. + + + + + Selected and hot-tracked items are not skinned and painted using the default system color. + + In a control’s descendants, if item hot-tracking is enabled, selected and hot-tracked items are always in sync, and setting the BaseListBoxControl.HotTrackSelectMode property to SelectItemOnClick is not in effect. + + + + + Enumerates values that specify how list box items are selected when item hot-tracking is enabled. + + + + + If item hot-tracking is enabled, an item is selected when clicked. This option is not in effect if the BaseListBoxControl.HighlightedItemStyle property is set to HighlightStyle.Standard. + + + + + If item hot-tracking is enabled, an item is selected when hovering over it with the mouse. + + + + + The same as the HotTrackSelectMode.SelectItemOnHotTrack option plus the following. + If item skinning is enabled via the BaseListBoxControl.HighlightedItemStyle option, the BaseListBoxControl.SelectedIndexChanged event is raised each time an item is hot-tracked. + In HotTrackSelectMode.SelectItemOnHotTrack mode, the BaseListBoxControl.SelectedIndexChanged event is raised only when clicking the item. + + + + + Renders a UI from HTML-CSS markup. Can show data from a bound data context (a business object or data source item). + + + + + Initializes a new instance of the class. + + + + + Gets the active in-place editor defined in HTML markup by an ‘input’ tag with an embedded Repository Item. + + The child active editor. + + + + Gets or sets whether users can select the contents of HTML tags. + + Specifies the initial value of the user-select CSS property for all HTML elements. The DefaultBoolean.True value sets this property to auto, the DefaultBoolean.False and DefaultBoolean.Default values set it to none. + + + + Gets or sets whether the HtmlContentControl can be focused. + + true if the control can be focused; otherwise, false. + + + + Contains the control’s appearance settings. + + The control’s appearance settings. + + + + Gets or sets whether the HtmlContentControl, which is a container of child controls, enables a user to scroll to any child control placed outside the container’s visible boundaries. + + true if the control displays scroll bars to scroll to child controls placed outside the container’s visible boundaries; false, if scroll bars are hidden. + + + + Uses the command selector to find an appropriate parameterized MVVM command in the source, and binds this command to the target HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Binds the parameterized MVVM command to the target HTML element. + + The command to be bound to this HTML element. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Uses the command selector to find an appropriate parameterized MVVM command in the source, and binds this command to the target HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a command. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Returns information about visual elements located at a specified point. + + Test point coordinates relative to the HtmlContentControl’s top-left corner. + An object that contains information about visual elements located at the test point. + + + + Closes the currently opened in-place editor and saves changes made by a user. This member is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Allows you to specify custom display text for bound field values. + + + + + Allows you to assign custom in-place editors (Repository Items) to individual <input> tags. The event is not in effect for <input> tags used to embed external controls. + + + + + Allows you to specify custom in-place editors (Repository Items) for individual <input> tags in edit mode. The event is not in effect for <input> tags used to embed external controls. + + + + + Gets or sets the control’s data context (a business object or data source item). + + The data context. + + + + Fires immediately after the active in-place editor’s value is changed. This member is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Fires when a user changes the active editor’s value — types or deletes a character, chooses a value from the dropdown list, etc. The event does not fire when you change the value in code. + + + + + Occurs when a user clicks any HTML element. + + + + + Occurs when a mouse button is pressed over an HTML element. + + + + + Occurs when a mouse pointer moves while over an HTML element. + + + + + Occurs when a mouse pointer leaves the bounds of an HTML element. + + + + + Occurs when a mouse pointer enters the bounds of an HTML element. + + + + + Occurs when a mouse button pressed over an HTML element is released. + + + + + Returns an HTML element with the specified ID. + + The ID of an element to be retrieved. + The element that has the specified ID. + + + + Returns a list of HTML elements that are of the specified class. + + The class of HTML elements to be retrieved. + A list of HTML elements that are of the specified class. + + + + Returns a list of HTML elements that have the specified tag. + + The tag of HTML elements to be retrieved. + A list of HTML elements that have the specified tag. + + + + Sets focus to or removes focus from the specified element. + + The target HTML element. + true to focus an element; false to remove focus from the element. + + + + Sets focus to or removes focus from the element with the specified ID. + + The ID of the element to be focused. + true to focus an element; false to remove focus from the element. + + + + Forces the control to finish its initialization. + + + + + Performs an action on all or specific HTML elements. + + An action to perform on HTML elements. + An optional parameter that specifies a condition to narrow the set of target items. + + + + Returns the rectangle that the control’s contents occupy. + + The bounds of the control’s contents. + + + + Returns the specified field’s value from the bound data object (HtmlContentControl.DataContext). + + The name of a target field in the bound data object. + The specified field’s value. + + + + Fires immediately after an in-place editor is closed (it loses focus). The HiddenEditor event is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Closes the currently opened editor and discards changes made in the edit box. This member is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Gets or sets the source of images to display using <img> tags. + + A source of images. + + + + Gets the control’s HTML-CSS template. + + The control’s HTML-CSS template. + + + + For internal use. + + A Boolean value. + + + + Occurs when the control is redrawn. Allows you to paint the control when any rendering engine (DirectX or GDI+) is applied. + + + + + Saves changes made by a user. This member is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Forces the control to invalidate its client area and immediately redraw itself. + + + + + Returns the text contents of all currently selected HTML elements. See this property for more information: AllowContentSelection. + + The text contents of all currently selected HTML elements. + + + + Occurs when the SelectedText property value changes. See this property for more information: AllowContentSelection. + + + + + Sets the specified field’s value in the bound data object (HtmlContentControl.DataContext). + + The name of a target field in the bound data object. + The field’s new value. + + + + Activates an in-place editor bound to the specified field. This member is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + The field name to which the in-place editor is bound in HTML markup. + + + + Fires when an in-place editor is about to be activated (created). The ShowingEditor event is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Fires after an in-place editor is activated. The ShownEditor event is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for the . + + A value that specifies whether the DirectX Hardware Acceleration is enabled. + + + + Fires when a user edits the active in-place editor’s value and attempts to move focus away from (close) the editor. The ValidatingEditor event is only in effect for in-place editors (Repository Items) added to the UI using the ‘input’ tag. + + + + + Allows you to show a popup window with a UI rendered from an HTML-CSS template. Can show data from a bound data context (a business object or data source item). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + A container that will own the created object. + + + + Activates the current window. + + + + + Contains the window’s appearance settings. + + The window’s appearance settings. + + + + Gets or sets a delay after which the HtmlContentPopup (opened as a popup window) is automatically closed if the HtmlContentPopup.HideAutomatically property is enabled. + + A delay after which the HtmlContentPopup (opened as a popup window) is automatically closed. + + + + Uses the command selector to find an appropriate parameterized MVVM command in the source, and binds this command to the target HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Binds the parameterized MVVM command to the target HTML element. + + The command to be bound to this HTML element. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Uses the command selector to find an appropriate parameterized MVVM command in the source, and binds this command to the target HTML element. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + The unique ID of the target HTML element. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a command. + An IDisposable object. Disposing of this object unbinds the command from this HTML element. + + + + Calculates the popup size required to fit its content without exceeding the maximum width. + + The owner of this popup. + The maximum allowed popup width. + The optimal popup size required to fit the popup content. + + + + Closes the window. + + + + + Closes the HtmlContentPopup object that was opened as a modal window, and sets the dialog result. + + The dialog’s result. + + + + Fires after the window is closed. This is a notification event. + + + + + Fires when the window is about to be closed. Allows you to cancel the close operation. + + + + + Allows you to specify custom display text for bound field values. + + + + + Fires before a popup is shown on-screen and allows you to modify the HTML-CSS template of this HtmlContentPopup component. + + + + + Gets or sets the window’s data context (a business object or data source item). + + The data context. + + + + Occurs when a user clicks any HTML element. + + + + + Occurs when a user double-clicks any HTML element. + + + + + Occurs when a mouse button is pressed over an HTML element. + + + + + Occurs when a mouse pointer moves while over an HTML element. + + + + + Occurs when a mouse pointer leaves the bounds of an HTML element. + + + + + Occurs when a mouse pointer enters the bounds of an HTML element. + + + + + Occurs when a mouse button pressed over an HTML element is released. + + + + + Fires when a window is hidden. + + + + + Makes the window invisible. + + + + + Gets or sets whether the HtmlContentPopup (opened as a popup window) is automatically closed after a specific delay (HtmlContentPopup.AutoHidingDelay). + + A value that specifies whether the HtmlContentPopup (opened as a popup window) is automatically closed after a specific delay. + + + + Gets or sets whether the HtmlContentPopup is hidden when a user clicks any element within this popup. + + A value that specifies whether the HtmlContentPopup is hidden when a user clicks any element within this popup. + + + + Gets or sets the source of images to display using <img> tags. + + A source of images. + + + + Gets the window’s HTML-CSS template. + + The window’s HTML-CSS template. + + + + Displays the HtmlContentPopup as a popup window within the specified bounds. + + The window’s owner. + The rectangle to fit the window. + + + + Displays the HtmlContentPopup object as a modal window within the specified bounds. + + The window’s owner. + The rectangle to fit the window. + The dialog’s result. + + + + Gets or sets an object that stores custom data. + + An object that stores custom data. + + + + Gets or sets the component that controls the behavior and appearance of hints displayed for HTML elements. + + An object that specifies hint settings. + + + + The editor to display and edit hyperlinks and navigate to their targets. + + + + + Creates an instance of the control. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Occurs before hyperlink execution. + + + + + Contains settings specific to the hyperlink editor. + + A object containing settings for the current editor. + + + + Executes the command specified by the hyperlink editor as a new process. + + + + + Executes the specified command as a new process. + + The object representing the command to execute. + + + + Gets or sets the text representing the command for the hyperlink editor. + + A string representing the command for the hyperlink editor. + + + + The label that supports displaying text or its portion as a hyperlink. Allows you to use HTML tags to format text. + + + + + Initializes a new instance of a class with the default settings. + + + + + This property is not supported by the . + + + + + Provides access to appearance settings used to paint the . + + An object that specifies the appearance settings used to paint the control. + + + + Provides access to appearance settings used to paint the when it is disabled. + + An object that specifies the appearance settings used to paint the control. + + + + Provides access to appearance settings used to paint the when it is hovered. + + An object that specifies the appearance settings used to paint the control. + + + + Provides access to appearance settings used to paint the when it is pressed. + + An object that specifies the appearance settings used to paint the control. + + + + Gets or sets when links should be underlined. + + A value that specifies when links should be underlined. + + + + Gets or sets whether to display links within a as visited links. + + true if links are displayed as visited links; otherwise, false. + + + + Contains appearance settings that paint a . + + + + + Initializes a new instance of a class with the default settings. + + + + + Gets or sets the color used to display links within a disabled (when its Enabled property is set to false). + + A color used to display disabled links. + + + + Gets or sets the color used to display normal links. + + An object that specifies the color used to display normal links. + + + + Provides access to the appearance options. + + An object that specifies the appearance options. + + + + Gets or sets the color used to display links when the is pressed. + + A color used to display links in the pressed state. + + + + Gets or sets the color used to paint visited links. + + A color used to paint visited links. + + + + Contains appearance options that paint a . + + + + + Initializes a new instance of a class with the default settings. + + + + + Copies all settings from the options object passed as the parameter and assigns them to the current object. + + An object whose settings are assigned to the current object. + + + + Determines whether the specified object and the current object have the same property values. + + An object to be compared with the current object. + true if the current object has the same property values as the specified object; otherwise, false. + + + + Gets or sets whether to use the HyperlinkLabelControlAppearanceObject.DisabledColor property value. + + true, if the HyperlinkLabelControlAppearanceObject.DisabledColor property value is used; false, if the default color is used. + + + + Gets or sets whether to use the HyperlinkLabelControlAppearanceObject.LinkColor property value. + + true, if the HyperlinkLabelControlAppearanceObject.LinkColor property value is used; false, if the default color is used. + + + + Gets or sets whether to use the HyperlinkLabelControlAppearanceObject.PressedColor property value. + + true, if the HyperlinkLabelControlAppearanceObject.PressedColor property value is used; false, if the default color is used. + + + + Gets or sets whether to use the HyperlinkLabelControlAppearanceObject.VisitedColor property value. + + true, if the HyperlinkLabelControlAppearanceObject.VisitedColor property value is used; false, if the default color is used. + + + + Lists the values that specify how an image is aligned relative to the label’s text. + + + + + The image is vertically aligned at the bottom, and horizontally aligned at the center. + + + + + + The image is vertically aligned at the bottom, and horizontally aligned on the left. + + + + + + The image is vertically aligned at the bottom, and horizontally aligned on the right. + + + + + + The image is horizontally aligned on the left and vertically aligned at the bottom. + + + + + + The image is horizontally aligned on the left and vertically aligned at the center. + + + + + + The image is horizontally aligned on the left and vertically aligned at the top. + + + + + + The image isn’t aligned relative to the label’s text. The alignment of the image is specified by the label’s appearance settings (LabelControlAppearanceObject.ImageAlign). + + + + + The image is horizontally aligned on the right and vertically aligned at the bottom. + + + + + + The image is horizontally aligned on the right and vertically aligned at the center. + + + + + + The image is horizontally aligned on the right and vertically aligned at the top. + + + + + + The image is vertically aligned at the top, and horizontally aligned at the center. + + + + + + The image is vertically aligned at the top, and horizontally aligned on the left. + + + + + + The image is vertically aligned at the top, and horizontally aligned on the right. + + + + + + The combo box editor whose items can display custom images. The control also allows values from an enumeration to be displayed. + + + + + Creates an instance of the image combo box editor. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Gets or sets the editor’s value. + + The object representing the edit value. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupImageComboBoxEditListBoxForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets settings specific to the image combo box editor. + + The object containing settings for the current editor. + + + + Gets or sets the selected item. + + A selected item. + + + + Locates the first item with the specified description and selects it. + + A string value that specifies the item description. + + + + Gets or sets the text displayed in the edit box. + + The string displayed in the edit box. + + + + Gets or sets the editor’s value. + + The object representing the edit value. + + + + The editor that displays images in a popup window. + + + + + Initializes a new control instance with default settings. + + + + + Closes the popup window. + + + + + Gets the class name of the current editor. + + A object identifying the class name of the current editor. + + + + Gets or sets an object representing an image stored by the image editor. + + A value representing an image stored by the image editor. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.ImagePopupForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Sets or gets the image displayed by the editor. + + A object representing the image displayed by the editor. + + + + Occurs after the value of the ImageEdit.Image property has been changed. + + + + + Gets an object containing settings specific to the image editor. + + A object instance containing settings for the control. + + + + Gets or sets an SVG image for an object to display. + + An SVG image the object displays. + + + + Gets or sets the colorization mode for the object’s SVG image. + + Colorization mode. + + + + Gets or sets the size of SVG images assigned to an object. + + The SVG image size. + + + + Gets a value representing the display representation of the editor’s BaseEdit.EditValue property. + + A value standing for the display representation of the editor’s edited value. + + + + The list box control that displays a list of items that a user can select. Can be populated with items from a data source. + + + + + Creates a new object. + + + + + Enables you to sort list items in custom order. + + + + + Enumerates possible locations for an image within a control. + + + + + The image is vertically aligned at the bottom, and horizontally aligned in the center. + + + + + The image is vertically aligned at the bottom, and horizontally aligned on the left. + + + + + The image is vertically aligned at the bottom, and horizontally aligned on the right. + + + + + The same as MiddleLeft. + + + + + The image is centered vertically and horizontally. The control’s text is not displayed in this mode. + + + + + The image is vertically centered, and horizontally aligned on the left. + + + + + The image is vertically centered, and horizontally aligned on the right. + + + + + The image is vertically aligned at the top, and horizontally aligned in the center. + + + + + The image is vertically aligned at the top, and horizontally aligned on the left. + + + + + The image is vertically aligned at the top, and horizontally aligned on the right. + + + + + Stores available draw mode options for Step Progress Bar Item indicators. + + + + + Same as Full. + + + + + An indicator outline is visible, and the central indicator area is filled with the outline color. + + + + + Neither the indicator outline nor central area are visible. If assigned, an indicator icon is the only element visible in this mode. + + + + + An indicator outline is visible, and the central indicator area is empty. + + + + + Lists values that specify how the label is automatically resized to display its entire contents. + + + + + In Visual Studio 2002 and 2003, the same as the None option. + In Visual Studio 2005 and more recent versions, the same as the Horizontal option. + + + + + The label is automatically resized to display its entire contents horizontally. The label’s size depends only on the length of the text and the font settings, the label cannot be resized by an end-user. + + + + + Disables the auto size mode. An end-user is allowed to change both the label’s width and height. + + + + + The label’s height is automatically changed to display its entire contents. In this instance, an end-user can change the label’s width while its height is automatically adjusted to fit the label’s text. + + + + + The label that supports formatted text, images, multi-line text strings and HTML formatting. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether the label image is painted based on the label’s foreground color. + + true if the label image is painted based on the label’s foreground color; otherwise, false. + + + + Gets or sets whether HTML formatting is allowed. + + true if HTML formatting is allowed; otherwise, false. + + + + Gets the appearance settings used to paint the label. + + A object which contains the label’s appearance settings. + + + + Provides access to the appearance settings applied when the current label is disabled. + + A object that specifies the appearance settings applied when the current label is disabled. + + + + Provides access to the appearance settings applied when the current label is hovered over with the mouse pointer. + + A object that specifies the appearance settings applied when the current label is hovered over with the mouse pointer. + + + + Provides access to the appearance settings applied when the current label is clicked. + + A object that specifies the appearance settings applied when the current label is clicked. + + + + Gets or sets whether the control displays the ellipsis character for truncated text. + + true if the control displays the ellipsis character for truncated text; otherwise, false. + + + + Supports the internal infrastructure. Use the LabelControl.AutoSizeMode property instead. + + true if the editor’s width is changed to display the editor’s content in its entirety; otherwise, false. + + + + Gets or sets the direction in which the label grows to display its entire contents. + + The direction in which the label grows to display its entire contents. + + + + Gets or sets the label control’s background color. + + A value that specifies the control’s background color. + + + + Gets or sets the label’s background image. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + An that represents the label’s background image. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + An value that specifies the position of an image on the control. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds a command to this . + + An Object that is the command bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the specific type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A value. + + + + Returns the Y coordinate of the text base line. + + An integer value that specifies the Y coordinate of the text base line. + + + + Gets or sets a collection of images that can be inserted into the label using the image tag. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Occurs whenever an end-user clicks a hyperlink contained within the current . + + + + + Gets or sets a value that specifies how the image is aligned relative to the label’s text. + + An value that specifies how the image is aligned relative to the label’s text. + + + + Provides access to properties that allow you to set up raster and vector images for this . + + A DevExpress.XtraEditors.LabelControlImageOptions object that provides access to image-related settings. + + + + Gets or sets the indent between the image and text of the current . + + An value specifying the indent between the image and text of the , in pixels. + + + + Gets or sets the color of the label’s line. + + A value that specifies the line’s color. + + + + Gets the location of the LabelControl’s line relative to the text. + + A DevExpress.XtraEditors.LineLocation value that specifies the line location. + + + + Gets or sets the orientation of the LabelControl’s line. + + A DevExpress.XtraEditors.LabelLineOrientation value that specifies the line’s orientation. + + + + Gets or sets the paint style of the LabelControl’s line. This property is in effect when a label is painted using any paint theme, except skins. + + A value that specifies the paint style of the LabelControl’s line. + + + + Gets or sets whether a line is displayed when the label’s width extends the width of its text. + + true to display the line when the label’s width extends the width of its text; otherwise, false. + + + + Gets the label’s plain text, stripping out HTML tags. + + A String value representing the label’s text without HTML tags. + + + + Gets the actual auto-size mode. + + A value. + + + + Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. + + One of the values. + + + + Gets or sets whether the ‘s line has a shadow. This property is in effect when a label is painted using any paint theme, except skins. + + true if the ‘s line has a shadow; otherwise, false. + + + + Starts the animation of an animated GIF file being displayed in the label. + + + + + Stops animation of an animated GIF file being displayed in the label. + + + + + Gets or sets whether an end-user can tab to the label. + + true if tabbing moves focus to the label; otherwise, false. + + + + Gets or sets the label’s text. + + A value that specifies the label’s text. + + + + Gets or sets a value indicating whether the label interprets an ampersand character (&) in its Text property to be an access key prefix character. + + true if the label doesn’t display the ampersand character and underlines the character after the ampersand in its displayed text and treats the underlined character as an access key; false if the ampersand character is displayed in the label’s text. + + + + Contains appearance settings used to paint a . + + + + + Initializes a new instance of the class. + + + + + Copies all settings from the appearance object passed as a parameter. + + An object or its descendant that represents the source of the operation. + + + + Duplicates this . + + An Object that is this ‘s copy. + + + + Copies the activated appearance settings of objects passed as the first parameter to the current object; properties that aren’t activated are set to values specified by the second parameter + + An array of appearance objects that specifies the source of the operation. + An object that specifies the default appearance settings. + + + + Gets or sets the image to be displayed within the label when the control is disabled. + + A object that is displayed when the control is disabled. + + + + Gets or sets the index of the image to be displayed within the label when the control is disabled. + + An integer value that represents a zero-based index of an image in the LabelControlAppearanceObject.ImageList collection. + + + + Releases all resources used by the current appearance object. + + + + + This method supports the internal infrastructure and is not intended to be called directly from your code. + + + + + Gets the image to be displayed in a label control. + + An object to be displayed in the label. + + + + Gets the image to be displayed in the label, control according to its state. + + The label control’s state. + An image to be displayed. + + + + Returns an image displayed in the label. + + An object specifying an image displayed in the label. + + + + Gets or sets the image to be displayed within the label when the control is hovered over. + + A object that is displayed when the control is hovered over. + + + + Gets or sets the index of the image to be displayed within the label when the control is hovered over. + + An integer value that represents a zero-based index of an image in the LabelControlAppearanceObject.ImageList collection. + + + + Stores the image that will be shown inside the . + + The image that will be shown inside the . + + + + Gets or sets the alignment of the image within the label. + + A enumeration value that specifies the alignment of the image within the label. + + + + Gets or sets the index of the image displayed within the label. + + An integer value that specifies the zero-based index of the image displayed within the label. + + + + Gets or sets the source of images to be displayed within the label. + + An object that is an image collection providing images for the . + + + + Provides access to the appearance object’s options. + + A DevExpress.XtraEditors.LabelControlAppearanceObject object containing the appearance options. + + + + Gets or sets the image to be displayed within the label when the control is pressed. + + A object that is displayed when the control is pressed. + + + + Gets or sets the index of the image to be displayed within the label when the control is pressed. + + An integer value that represents a zero-based index of an image in the LabelControlAppearanceObject.ImageList collection. + + + + Resets all properties to their default values. + + + + + The Line view of the chart range control client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The scale factor. + + + + Gets or sets whether anti-aliasing (smoothing) is applied to the line view of the chart range control client. + + True to apply anti-aliasing to the line view of the chart range control client; False to disable anti-aliasing. + + + + Specifies the width of a line in a . + + An integer value specifying the line width (in pixels). + + + + Gets or sets the color used to draw line markers. + + A that defines the color used to draw line markers. + + + + Gets or sets the size of markers for data points in a . + + An integer value specifying the marker size, in pixels. + + + + Gets or sets a value that specifies the visibility of point markers on a . + + true to show markers for each data point; false to hide them. + + + + A control that displays a list of items that a user can select. This control can be populated with items from a data source. + + + + + Creates a new object. + + + + + Enables you to sort list items in custom order. + + + + + Accesses the item collection, when the control is not bound to a data source. + + A object representing items within the list box control. + + + + Supplies data for the BaseListBoxControl.DrawItem event. + + + + + Initializes a new instance of the class with the specified settings. + + A object that is a storage for pens, fonts and brushes used during painting. + An object that stores appearance settings used to paint the item. This value is assigned to the ListBoxDrawItemEventArgs.Appearance property. + A Rectangle structure that specifies the bounding rectangle of the item. This value is assigned to the ListBoxDrawItemEventArgs.Bounds property. + An Object that is the value of the item. This value is assigned to the ListBoxDrawItemEventArgs.Item property. + An integer value that specifies the index of the item. This value is assigned to the ListBoxDrawItemEventArgs.Index property. + A DrawItemState enumeration value that specifies the state of the item. This value is assigned to the ListBoxDrawItemEventArgs.State property. + A Boolean value that specifies whether the item background is colored according to the currently applied skin, or based on the specified appearance settings. This value is assigned to the ListBoxDrawItemEventArgs.AllowDrawSkinBackground property. + + + + Gets or sets whether the item background is colored according to the currently applied skin. + + true if the item background is colored according to the currently applied skin; otherwise, false. The default is true. + + + + Gets the appearance settings used to paint the item currently being processed. + + A object which provides the appearance settings used to paint the item. + + + + Gets the bounding rectangle of the item being painted. + + A structure specifying the painted item’s boundaries. + + + + Gets the index of the item being painted. + + An integer value representing the zero-based index of the item being painted. + + + + Gets the value of the processed item. + + An object representing the value of the processed item. + + + + Gets the state of the item being painted. + + A enumeration member specifying the current state of an item being painted. + + + + A method that handles the BaseListBoxControl.DrawItem event. + + The event sender (typically the list box control). + A object that contains data related to the event. + + + + A text box editor with a dropdown panel that displays data in a simple table layout. + + + + + Creates an instance of the class. + + + + + Notifies the accessibility client applications of the specified event for the specified child control. + + An event being fired. + The identifier of the AccessibleObject. + A child that fires the event. + + + + Fires only when the editor SearchMode property equals AutoSearch. In this mode, the editor filters out data source records that do not match the currently entered text, and displays remaining records in the drop-down panel. The AutoSearch event is optional, it allows you to fine-tune the search. See the class description to learn more. + + + + + Fires when a search in mode completes. + + + + + Fires only when the SearchMode property equals AutoSuggest. In this mode, the editor runs the asynchronous Task assigned in the event handler to retrieve a list of drop-down panel items. See the class description for more information. + + + + + Fires after the LookUpEdit.AutoSuggest event is finished. Allows you to additionally customize the editor. + + + + + Provides the capability to perform custom painting of grid cells in the drop-down. + + + + + Provides the capability to perform custom painting of grid column headers in the drop-down. + + + + + Provides the capability to perform custom painting of vertical grid lines in the drop-down. + + + + + Provides the capability to perform custom painting of grid rows in the drop-down. + + + + + Occurs after the property has been changed. + + + + + Gets the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Returns the value of the specified column for the currently selected row in the dropdown. + + A object identifying the column whose value should be returned. + An object representing the column’s value in the current row. + + + + Returns the value of a specific column for the currently selected row in the dropdown. + + A string identifying the field whose value should be returned. + An object representing the column’s value in the current row. + + + + Occurs when retrieving values for fields not found in the RepositoryItemLookUpEditBase.DataSource. + + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupLookUpEditForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Returns a data source row corresponding to the currently selected edit value. + + An object that represents a data source row corresponding to the currently selected edit value. + + + + Gets whether the text in the edit box matches the RepositoryItemLookUpEditBase.DisplayMember field value of any row in the dropdown. This property is for internal use. + + true if the text in the edit box matches the RepositoryItemLookUpEditBase.DisplayMember field value of any row in the dropdown; otherwise, false. + + + + Gets or sets the index of the selected row in the dropdown. + + The zero-based index of the selected row in the editor’s dropdown. -1 if no row is currently selected, or the data source is not specified. + + + + Occurs after a record(s) in the RepositoryItemLookUpEditBase.DataSource has been changed. + + + + + Allows you to explicitly set the expression to filter lookup items. + + + + + Specifies settings specific to the current editor. + + A object containing settings for the lookup editor. + + + + Allows you to select items based on values in the data source field specified by the property. + + + + + Resets selection and caret position in the editor. + + + + + Occurs after a user selects an item in the editor’s popup. This event works in Multiple Item Selection mode only. + + + + + Occurs before a user selects an item in the editor’s popup. This event works in Multiple Item Selection mode only. + + + + + Allows you to post values that correspond to the selected item state to the data source field specified by the property. + + + + + Gets the text displayed in the edit box. + + The text displayed in the edit box. + + + + The base class for lookup editors. + + + + + The DefaultBoolean.Default value. + + The DefaultBoolean.Default value. + + + + Gets or sets the lookup editor whose value determines the filter criteria applied to the popup data source of the current lookup editor. + + The lookup editor whose value determines the filter criteria applied to the popup data source of the current lookup editor. + + + + When implemented by a class, this method returns a data source row corresponding to the currently selected edit value. + + An object that represents a data source row corresponding to the currently selected edit value. + + + + Occurs when a new value entered into the edit box is validated. + + + + + Gets an object containing properties and methods specific to a lookup editor. + + A object instance containing settings specific to a lookup editor. + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + When this editor operates in AutoSearch Mode (the SearchMode property is set to “AutoSearch”), call this method to clear all cached suggestions and custom highlight regions. + + true if suggestions and highlight regions were successfully cleared; otherwise, false. + + + + When this editor operates in AutoSuggest Mode (the SearchMode property is set to “AutoSuggest”), call this method to clear all cached suggestions and custom highlight regions. + + + + + Sets the current editor text and triggers the AutoSearch event (LookUpEdit.AutoSearch or GridLookUpEdit.AutoSearch). + + The new editor text. This value is passed to the event’s “Text” parameter. + true if the editor should select its current text; otherwise, false. + true if the event was successfully triggered and the auto-search occurred; otherwise, false. + + + + Sets the current editor text and triggers the AutoSuggest event (LookUpEdit.AutoSuggest or GridLookUpEdit.AutoSuggest). + + The new editor text. This value is passed to the event’s “Text” parameter. + true if the editor should select its current text; otherwise, false. + true if the event was succesfully triggered; otherwise, false. + + + + Gets or sets whether to suppress the Invalid Value Type warning for all lookup editors in a WinForms application. + + to suppress the warning when the editor is bound to a value of incompatible type; , to warn about incompatible type only once; , to warn about incompatible type only once. + + + + Indicates that an operation is going on by continuously scrolling a block from left to right. + + + + + Initializes a new instance of the class. + + + + + Gets the editor’s class name. + + The string that represents the editor’s class name. + + + + Gets an object which contains properties, methods and events specific to marquee progress bar controls. + + A object that contains marquee progress bar settings. + + + + Contains utility classes supporting editor masks. + + + + + Lists values that specify the type of automatic completion mode used by an editor. + + + + + When set to Default, the AutoCompleteType.Strong automatic completion mode is used. + + + + + The automatic completion feature is disabled. + + + + + When an end-user enters a character in an empty edit box for the first time, the editor automatically fills all the following placeholders with the default values. For placeholders that accept only numeric values, the ‘0’ character is the default. For placeholders that accept alpha characters, the “a” character is the default. + + + + + Each time an end-user types a character the editor determines if the following placeholder can be filled automatically. If only a specific character can be inserted in this position the editor automatically displays this character and moves the caret to the right of this character. + + + + + Contains settings that affect the functionality of an editor’s mask. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with settings from the specified MaskData object. + + A DevExpress.XtraEditors.Controls.MaskData object whose settings are used to initialize the newly created object. + + + + Occurs after a setting of the current object has been changed. + + + + + Copies the settings from the specified object to the current object. + + A object whose settings are assigned to the current object. + + + + Gets or sets the automatic completion mode used by the editor in the RegEx mask mode. + + An value specifying the automatic completion mode used by the editor in the RegEx mask mode. + + + + Gets or sets whether an editor makes a beep sound when an end-user tries to enter an invalid character. + + true if the editor sounds a beep when an end-user tries to enter an invalid character; otherwise, false. + + + + Occurs when a setting of the current object is about to be changed. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Gets or sets a character representing a placeholder within a masked editor. + + A string whose first character is used as a placeholder. + + + + Creates the default mask manager. + + A MaskManager object that represents the default mask manager. + + + + Gets or sets the culture whose settings are used by masks. + + A object whose settings are used by masks. + + + + Gets or sets a mask expression. + + A string representing a mask expression. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Determines whether the current object has the same settings as the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + For the Simple, Regular and RegEx mask types this property gets or sets whether an editor can lose focus when a value hasn’t been entered. + + true if an editor can lose focus when a value has not been entered; otherwise, false. + + + + Gets or sets the mask type. + + A value specifying the mask type used. + + + + For the Simple, Regular and RegEx mask types this property gets or sets the character used as the placeholder in a masked editor. + + The character used as the placeholder in a masked editor. + + + + For the Simple and Regular mask types this property gets or sets whether constantly displayed mask characters (literals) are included in an editor’s value. + + true if the constantly displayed mask characters are included in an editor’s value; otherwise, false. + + + + For the RegEx mask type this property gets or sets whether placeholders are displayed in a masked editor. + + true to display placeholders in a masked editor; otherwise false. + + + + Returns the text representation of the current object. + + A string that specifies the text representation of the current object.. + + + + Gets or sets whether display values are still formatted using the mask when the editor is not focused. + + true if the mask settings are used to format display values when the editor is not focused; false if the RepositoryItem.DisplayFormat object’s settings are used instead. + + + + Lists values that specify the type of mask used by an editor. + + + + + Specifies that the editor uses a custom mask manager. + To implement a custom mask manager which will deal with masks in a custom manner create a custom editor and override its CreateMaskManager method. This method should then supply a custom mask manager when the MaskProperties.MaskType property is set to Custom. + + + + + Specifies that the editor should accept date/time values and that the mask string must use the DateTime format syntax. + + + + + The DateTime mask mode with the caret automatic movement feature. + After an end-user enters and completes a specific portion of a date/time value the caret automatically moves to the following part of the date/time value that can be edited. + + + + + Specifies that the mask feature is disabled. + + + + + Specifies that the editor should accept numeric values and that the mask string must use the Numeric format syntax. + + + + + Specifies that the mask should be created using full-functional regular expressions. + + + + + Specifies that the mask should be created using simplified regular expression syntax. + + + + + Specifies that the mask should use the simplified syntax. + + + + + Specifies that the editor should accept time span values. + + + + + Specifies that the editor should accept time span values. Supports the caret automatic movement feature. + + + + + Allows you to display and edit multi-line text. + + + + + Initializes a new control instance with default settings. + + + + + Appends the specified string as a new line to . + + The new line. + + + + Calculates the control height, in pixels, sufficient to display all lines of the text without the need to scroll it vertically. + + An integer value that specifies the control height, in pixels, sufficient to display all text lines. + + + + Gets the class name of the current editor. + + A object identifying the class name of the current editor. + + + + Gets or sets the lines of text within a memo edit control. + + An array of strings containing the text of a memo editor. + + + + Gets an object containing properties and methods specific to a memo editor. + + A object instance containing settings for the control. + + + + Gets or sets whether the control uses an optimized rendering mechanism. + + true if the control uses an optimized rendering mechanism; otherwise, false. + + + + The editor to edit multi-line text in a popup window. + + + + + Initializes a new class instance with default settings. + + + + + Gets the class name of the current editor. + + A object identifying the class name of the current editor. + + + + Returns the control’s popup window. + + A MemoExPopupForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets or sets the text lines to be displayed in the dropdown window of an extended memo edit control. + + An array of lines containing the text of a memo editor. + + + + Gets an object containing settings specific to the extended memo editor. + + A object instance containing settings for the extended memo editor. + + + + The text editor that allows you to type a value or choose one of most recently used (MRU) values from a dropdown list. + + + + + Initializes a new class instance with default settings. + + + + + Occurs before a new item is added to the MRU editor. + + + + + Gets the class name of the current editor. + + A object identifying the class name of the current editor. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupMRUForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets an object containing settings specific to the MRU editor. + + A object instance containing settings for the MRU editor. + + + + Occurs before an item is removed from the editor’s MRU list. + + + + + Serves as a base for and classes. + + + + + Gets or sets whether the control adjusts its size automatically, to display its buttons in their entirety. + + true if the control adjusts its size automatically to display its buttons in their entirety; otherwise, false. + + + + Enables you to perform custom actions when end-users click navigator buttons. + + + + + Gets or sets the navigator buttons’ style. + + A enumeration member specifying the style applied to the navigator buttons. + + + + Gets the collection of custom buttons. + + The collection of custom buttons. + + + + Gets the minimum size that can be applied to the navigator. + + A object representing the minimum size of the rectangular region that can be occupied by the navigator. + + + + Provides control over exceptional situations which might occur while navigating/editing records using the data navigator. + + + + + Gets or sets a value which specifies whether the navigator can display hints. + + true if the navigator can display hints; otherwise false. + + + + Gets or sets a value indicating whether the user can move focus to a navigator using the TAB key. + + true if the user can move focus to the control using the TAB key; otherwise, false. + + + + Gets or sets a value specifying the location of the text displayed within the navigator. + + A enumeration member specifying the text location. + + + + Gets or sets the string displayed within the control which identifies the current record and the total number of records. + + A string displayed within the Navigator control. + + + + Returns the object which contains internal information used to render the control. + + A DevExpress.XtraEditors.ViewInfo.NavigatorControlViewInfo object which contains internal information used to render the control. + + + + An individual button displayed within the DataNavigator or ControlNavigator . + + + + + Creates a new object. + + A NavigatorButtonHelper object implementing the button’s functionality. + + + + Gets the button’s type. + + A enumeration member specifying the button’s type. + + + + Indicates whether data records are scrolled repeatedly when this button is held down. + + true if data records are scrolled repeatedly when this button is held down; otherwise, false if one click on this button per record scrolled. + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Serves as a base for the class. + + + + + Initializes a new instance of the class. + + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + true if the button is enabled and a user can perform actions on it; otherwise, false. This value is assigned to the NavigatorButtonBase.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the NavigatorButtonBase.Visible property. + A value which represents the text displayed when the mouse pointer is over the button. This value is assigned to the NavigatorButtonBase.Hint property. + An object that contains information which is associated with the button. This value is assigned to the NavigatorButtonBase.Tag property. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this navigator button. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this navigator button. + + + + Binds the specific parameterized command to this navigator button. + + An Object that is the command to be bound to this navigator button. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this navigator button. + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this navigator button. + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this navigator button. + + + + Gets the button’s type. + + The NavigatorButtonType.Custom value. + + + + Occurs when a user clicks this navigator button. + + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets or sets whether the button is enabled and an end-user can perform actions on it. + + true if the button is enabled and an end-user can perform actions on it; otherwise, false. + + + + Gets or sets the button’s hint. + + A value which represents the text displayed when the mouse pointer is over the button. + + + + Gets or sets the index of the image to display within the button. + + An integer value which specifies the zero-based index of the image within the source collection. + + + + Gets the source of images to be displayed within the navigation buttons. + + An object which represents the source of images. + + + + Indicates whether data records are scrolled repeatedly when the button is held down. + + Always false. + + + + Gets or sets the data associated with the button. + + An object that contains information which is associated with the button. + + + + Gets or sets whether the button is visible. + + true if the button is visible; otherwise, false. + + + + Supplies data for the NavigatorBase.ButtonClick event. + + + + + Initializes a new instance of the class. + + A descendant which represents the button clicked. This value is assigned to the NavigatorButtonClickEventArgs.Button property. + + + + Gets the clicked button. + + A descendant which represents the button clicked. + + + + Gets or sets whether you have handled this event and no default action is required. + + true to prohibit the button’s default action; false to perform the button’s default action after your event handler is executed. + + + + A method that handles the NavigatorBase.ButtonClick event. + + The event sender (typically the descendant). + A object containing event data. + + + + Serves as a base for and classes. + + + + + Initializes a new instance of the class. + + A collection of buttons displayed within the control. + + + + Gets the button at the specified index. + + An integer value representing the button’s zero-based index. If negative or exceeds the maximum available index, an exception is raised. + A object representing the button at the specified position within the collection. + + + + Serves as the base for and classes. + + + + + Creates a new object. + + An object implementing the INavigatorOwner interface to which the object belongs. This value is assigned to the NavigatorButtonsBase.Owner property. + + + + Gets the appearance settings used to paint the buttons’ owner. + + A object which provides the appearance settings used to paint the buttons’ owner. + + + + Gets or sets the time interval which passes between the moment when an end-user holds down the navigation button and the data records are scrolled repeatedly. + + An integer value which specifies the time interval in milliseconds. + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Returns a value representing a data navigator button. + + A enumeration member specifying the button type. + A object representing the navigator’s button. null (Nothing in Visual Basic) if no button is found. + + + + Provides access to the collection of built-in buttons displayed in the DataNavigator control. + + A object representing the collection of built-in buttons. + + + + Specifies the control’s size. + + The object representing the control’s size. + + + + Gets the collection of custom buttons. + + A object, which is the collection of custom buttons. + + + + Gets the source of the images that are displayed within the navigation buttons by default. + + An object which contains the images displayed within the navigation buttons by default. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Simulates a mouse click action on the specified button. + + A object that represents the navigation button. + + + + Draws the text and buttons displayed in the data navigator. + + A GraphicsInfoArgs object used to paint. + + + + Specifies whether data records are scrolled repeatedly when the Next, NextPage, Prev or PrevPage button is held down. + + true if data records are scrolled repeatedly when the navigation button is held down; otherwise, one click on the navigation button per record scrolled. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Returns the index of the button to which the specified point belongs. + + A structure representing a point within the navigating control. + An object representing the index of the button to which the specified point belongs. null (Nothing in Visual Basic) if the specified point does not belong to a button. + + + + Gets the hint for the button located at the specified point. + + Reserved for future use. + A structure representing a point within the navigating control. + A string value representing the text displayed when the mouse pointer is over the data navigator button which the specified point belongs to. String.Empty if the specified point does not belong to a button. + + + + Gets or sets the source of images to be displayed within the navigation buttons. + + An object which represents the source of images. + + + + Redraws the control. + + + + + Gets the object that owns this button collection. + + An object implementing the INavigatorOwner interface to which the button collection belongs. + + + + Gets the control which owns the current collection. + + A descendant which represent the control which owns the current collection. + + + + Gets or sets the number of records by which the current record changes after the PrevPage or NextPage button has been pressed. + + An integer value specifying a number of records. + + + + Updates the buttons’ state and the text displayed within the control. + + + + + Contains values specifying the text location within the DataNavigator control. + + + + + The text is displayed on the left of the buttons, if the RightToLeft property value is false. Otherwise, the text is displayed on the right of the buttons. + + + + + + The text is displayed between Prev and Next buttons of the DataNavigator control. + + + + + + The text is displayed on the right of the buttons, if the RightToLeft property value is false. Otherwise, the text is displayed on the left of the buttons. + + + + + + The text is not displayed. + + + + + + Contains values specifying the type of buttons displayed in the data navigator control. + + + + + Inserts a new record after the last one. + + + + + Cancels edits to the current record. + + + + + Reserved for future use. + + + + + Sets the dataset to the edit state. + + + + + Posts edited record value to the associated data source. + + + + + Sets the current record to the first record in the data source. + + + + + Sets the current record to the last record in the data source. + + + + + Sets the current record to the next record in the data source. + + + + + When using the DataNavigator, changes the current record position in a data source by the DataNavigatorButtons.PageRecordCount property value upwards. In case of the ControlNavigator, changes the current record position in a data source by the count of visible onscreen records upwards. + + + + + Sets the current record to the previous record in the data source. + + + + + When using the DataNavigator, changes the current record position in a data source by the DataNavigatorButtons.PageRecordCount property value backwards. In case of the ControlNavigator, changes the current record position in a data source by the count of visible onscreen records backwards. + + + + + Deletes the current record and makes the next record the current record. + + + + + A custom button within navigator controls. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + The visual position of the current custom button within the combined list of the built-in and custom buttons. This value is assigned to the NavigatorCustomButton.Index property. + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + true if the button is enabled and a user can perform actions on it; otherwise, false. This value is assigned to the NavigatorButtonBase.Enabled property. + true if the button is visible; otherwise, false. This value is assigned to the NavigatorButtonBase.Visible property. + A value which represents the text displayed when the mouse pointer is over the button. This value is assigned to the NavigatorButtonBase.Hint property. + An object that contains information which is associated with the button. This value is assigned to the NavigatorButtonBase.Tag property. + + + + Initializes a new instance of the class with the specified settings. + + The visual position of the current custom button within the combined list of the built-in and custom buttons. This value is assigned to the NavigatorCustomButton.Index property. + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + true if the button is enabled and a user can perform actions on it; otherwise, false. This value is assigned to the NavigatorButtonBase.Enabled property. + A value which represents the text displayed when the mouse pointer is over the button. This value is assigned to the NavigatorButtonBase.Hint property. + + + + Initializes a new instance of the class with the specified visual position, image index and hint. + + The visual position of the current custom button within the combined list of the built-in and custom buttons. This value is assigned to the NavigatorCustomButton.Index property. + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + A value which represents the text displayed when the mouse pointer is over the button. This value is assigned to the NavigatorButtonBase.Hint property. + + + + Initializes a new instance of the class with the specified visual position and image index. + + The visual position of the current custom button within the combined list of the built-in and custom buttons. This value is assigned to the NavigatorCustomButton.Index property. + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + + + + Initializes a new instance of the class with the specified image index and hint. + + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + A value which represents the text displayed when the mouse pointer is over the button. This value is assigned to the NavigatorButtonBase.Hint property. + + + + Initializes a new instance of the class with the specified image index. + + An integer value which specifies the zero-based index of the image within the source collection. This value is assigned to the NavigatorButtonBase.ImageIndex property. + + + + Gets or sets the visual position of the current custom button within the combined list of the built-in and custom buttons. + + A zero-based value that specifies the visual position of the current custom button within the combined list of the built-in and custom buttons. -1 if the custom button is displayed at the end of this list. + + + + A collection of custom buttons in navigator controls. + + + + + Initializes a new instance of the class. + + A collection of buttons displayed within the control. + + + + Adds a new custom button to the current collection. + + The button added to the collection. + + + + Adds an array of buttons to the current collection. + + An array of button to be added to the current collection. + + + + Returns the button at the specified index within the current collection. + + An integer value representing the button’s zero-based index. If negative or exceeds the maximum available index, an exception is raised. + The button at the specified position within the current collection. + + + + Supplies data for the NavigatorBase.NavigatorException event. + + + + + Initializes a new instance of the class. + + A string value specifying the error description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A object representing the exception that raised the event. This value is assigned to the ExceptionEventArgs.Exception property. + The button whose press fired the exception. + + + + Initializes a new instance of the class. + + A string value specifying the error description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A string value specifying the error message box caption. This value is assigned to the ExceptionEventArgs.WindowCaption property. + A object representing the exception that raised the event. This value is assigned to the ExceptionEventArgs.Exception property. + A enumeration value specifying the response to entering an invalid value. This value is assigned to the ExceptionEventArgs.ExceptionMode property. + The button whose press fired the exception. + + + + Gets the navigator’s button which caused the exception when it was pressed. + + The button which raised the exception. + + + + A method that handles the NavigatorBase.NavigatorException event of data navigators. + + The data navigator control. + A object that contains event data. + + + + The ‘s client that renders a lightweight chart with a numeric horizontal axis. + + + + + Initializes a new instance of the class. + + + + + Provides access to the grid options of the numeric chart range control client. + + A object containing grid options for the numeric chart client of the range control. + + + + Provides access to the range settings of the numeric chart range control client. + + A object that contains settings to customize the range of the numeric chart range control client. + + + + Contains specific settings which define the representation of grid lines and labels in the numeric chart range control client. + + + + + Initializes a new instance of the class. + + + + + Contains the common settings that define the range displayed by a numeric chart client of the range control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the maximum value of a numeric chart client range. + + A value that is the maximum value of a range. + + + + Gets or sets the minimum value of a numeric chart client range. + + A value that is the minimum value of a range. + + + + A ‘s client that supports numeric (integer, double, decimal or float) range selection. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the end bound of the total range. + + An object that is the end bound of the total range. + + + + Gets or sets the start bound of the total range. + + An object that is the start bound of the total range. + + + + Gets or sets the ruler increment. This property also specifies the minimum increment for range selection. + + An object that is the ruler increment. + + + + An image combo box editor. + + + + + Creates an image combo box editor. + + + + + Displays images stored in bitmap, metafile, icon, JPEG, GIF, PNG or SVG format. The built-in editor allows users to perform basic edit operations (crop and straighten, adjust brightness, contrast and saturation, etc.) + + + + + Initializes a new class instance with default settings. + + + + + Returns information on the context button elements located at the specified point. + + A System.Drawing.Point structure which specifies the test point coordinates relative to the control’s top-left corner. + A DevExpress.Utils.ContextItemHitInfo object which comprises information about the context button elements located at the test point. + + + + Stops the asynchronous image load initiated by the PictureEdit.LoadAsync method. + + + + + Fires when a context button is clicked. + + + + + Copies the image currently displayed by the to the clipboard. + + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Clears the and copies is last image to the clipboard. + + + + + Gets a value indicating whether the picture editor is focused. + + true if the picture editor has focus; otherwise, false. + + + + Gets the class name of the current editor. + + A object identifying the class name of the current editor. + + + + Gets or sets the editor’s value. + + An object that is the editor’s value. + + + + Gets the full path to the image that has been loaded using the “Open File” dialog. + + The full path to the image that has been loaded using the “Open File” dialog. + + + + Gets the horizontal scroll position, in coordinates of the viewport. + + The horizontal scroll position, in coordinates of the viewport. + + + + Gets the horizontal scrollbar. + + A object which represents the horizontal scrollbar. + + + + Sets or gets the image displayed by the editor. + + A object representing the image displayed by the picture editor. + + + + Occurs after the value of the PictureEdit.Image or PictureEdit.SvgImage property has been changed. + + + + + Fires when the Image Editor dialog is closed. + + + + + Fires when the Editor dialog is about to be opened. Allows you to customize the dialog and its graphic commands. + + + + + Allows you to execute actions when a user loads a file via the control’s context menu. You can handle this event to perform image preprocessing or to load images stored in unsupported formats. + + + + + Allows you to execute actions when a user saves the current image via the control’s context menu. You can handle this event to perform image preprocessing or to save the image to a custom image format. + + + + + Converts the source image coordinates to the viewport coordinates, taking into account the current zoom level and scroll position. + + The source image coordinates to be converted. + The viewport coordinates. + + + + Loads the specified image, asynchronously. + + Security note: Downloading images passed as URLs to the LoadAsync method may create security issues. Review the following help topic and learn how to spot, analyze, and prohibit unwanted download requests: + Suppress Control Requests to Download Data from External URLs + + The path for the image to display in the . + The task. + + + + Fires when an asynchronous image load operation is completed, been canceled, or raised an exception. + + + + + Invokes the “Open File” dialog for the editor, allowing an end-user to load an image file. + + + + + Gets whether an asynchronous image load is in progress. + + true if an asynchronous image load is in progress; otherwise, false. + + + + A DirectX-compatible method that replaces the standard Control.Paint method. + + + + + Pastes the image stored in the clipboard to the . + + + + + Fires when the context menu is about to be displayed. + + + + + Gets an object containing properties and methods specific to the picture editor. + + A object instance containing settings for the control. + + + + Displays the Image Editor dialog, which allows users to perform basic edit operations on the image (crop, rotate, brightness and contrast adjustment, etc.). + + The DialogResult.OK value if the image has been modified and saved by the PictureEdit control; The DialogResult.Cancel value if changes (if any) made in the editor have been discarded. + + + + Displays the Take Picture dialog, which allows users to take snapshots from a connected webcam. + + DialogResult.OK, if the snapshot is taken; DialogResult.Cancel, if no snapshot is taken. + + + + Starts animation of an animated GIF file being displayed in the editor. + + + + + Stops animation of an animated GIF file being displayed in the editor. + + + + + Sets or gets the vector image displayed by the editor. + + A DevExpress.Utils.Svg.SvgImage object representing the vector image displayed by the picture editor. + + + + Gets or sets the colorization mode for the object’s SVG image. + + Colorization mode. + + + + Gets or sets the required size of the vector image. + + A structure that specifies the required size for rendering the vector image. + + + + Gets or sets a value indicating whether the user can tab to the picture editor. + + true if the user can focus the picture editor using the TAB key; otherwise, false. + + + + Fires when the Take Picture dialog is closed. Allows you to get the dialog result and captured image, and replace this image. + + + + + Fires when the Take Picture dialog is about to be displayed. Allows you to customize the dialog, and specify the camera device and resolution. + + + + + Gets a string value identifying the editor’s contents (a representation of the BaseEdit.EditValue property’s value). + + A value identifying the editor’s contents. + + + + Updates the position of the editor’s scroll bars, taking into account relevant properties. + + + + + Gets or sets whether or not this uses the DirectX Hardware Acceleration. + + A DefaultBoolean enum value that specifies whether or not this control employs the DirectX Hardware Acceleration. +To enable DirectX hardware acceleration, call the static WindowsFormsSettings.ForceDirectXPaint method and set UseDirectXPaint to DefaultBoolean.True. + + + + Gets the vertical scroll position, in coordinates of the viewport. + + The vertical scroll position, in coordinates of the viewport. + + + + Converts the viewport coordinates to the source image coordinates, taking into account the current zoom level and scroll position. + + The viewport coordinates to be converted. + The source image coordinates. + + + + Gets the vertical scrollbar. + + A object which represents the vertical scrollbar. + + + + Fires when the RepositoryItemPictureEdit.ZoomPercent property is changed. + + + + + The base class for dropdown editors that support the automatic search functionality. + + + + + Gets or sets the text used in an automatic search. + + A string that specifies the text used in an automatic search. + + + + Contains settings specific to the current editor. + + A object that contains the editor’s settings. + + + + Resets the selection and caret position in the editor. + + + + + Serves as the base for editors displaying popup windows. + + + + + Creates a new instance of the PopupBaseEdit class. + + + + + Indicates whether a mouse click should close this editor’s popup window. + + A object representing the clicked control. + A structure specifying the mouse pointer coordinates. + true if the popup window should remain opened after clicking; otherwise, false. + + + + Fires when the editor’s pop-up is about to be displayed. + + + + + Closes the popup window discarding the changes made. + + + + + Allows you to perform specific actions with respect to how the popup window was closed. + + + + + Closes the popup window accepting the changes made. + + + + + Enables you to specify whether the modifications performed within the editor’s popup window should be accepted by the editor. + + + + + Gets a value indicating whether the editor has input focus. + + true if the editor or its popup window has focus; otherwise, false. + + + + Gets the editor’s type name. + + The ‘PopupBaseEdit‘ string always. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns the control’s popup window. + + A PopupBaseForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Indicates whether a key should be processed by the editor or passed to its container control. + + A object specifying the key combination. + true if the key should be processed by the editor; otherwise, false + + + + Gets a value indicating whether the popup window is open. + + true if the popup window is open; otherwise, false. + + + + Occurs after the editor’s popup window has been opened. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the current ‘s closing behavior. + + A PopupCloseMode enumerator value that specifies the current ‘s closing behavior. + + + + Gets settings specific to the popup editor. + + The repository item containing settings specific to the popup editor. + + + + Enables you to specify whether an attempt to close the popup window will succeed. + + + + + Enables you to specify whether an attempt to open the popup window will succeed. + + + + + Updates the editor’s value by copying a value from the editor’s popup window to BaseEdit.EditValue. + + + + + Opens the popup window. + + + + + Contains values specifying how a dropdown editor’s popup window was closed. + + + + + Specifies that the dropdown window was closed because an end-user clicked the editor’s dropdown button. + + + + + Specifies that the dropdown window was closed because an end-user pressed the ESC key or clicked the close button (available for , and controls). + + + + + Specifies that the dropdown window was closed because an end-user pressed a shortcut used to close the dropdown (the ALT+DOWN ARROW or RepositoryItemPopupBase.CloseUpKey). + + + + + Specifies that the dropdown window was closed because an end-user clicked outside the editor. + + + + + Specifies that the dropdown window was closed because an end-user selected an option from the editor’s dropdown. + + + + + The dropdown panel for the editor. + + + + + Creates an instance of the class. + + + + + Gets the manner in which the control is docked. + + The DockStyle.None value always. + + + + Gets the editor which displays the current popup control. + + The object displaying the current popup control; null (Nothing in Visual Basic) if the popup control is not associated with an editor. + + + + Provides access to the owning editor’s repository item. + + A object containing settings of the editor whose popup window displays this control. + + + + Gets or sets whether the user can focus this control using the TAB key. + + false always. + + + + Gets or sets whether the popup control is visible. + + false always. + + + + The editor that allows you to display any controls within its popup window. The popup window is created separately from the editor. + + + + + Creates an instance of the class. + + + + + Validates the editor. + + A enumeration value that specifies how a dropdown editor’s popup window should be closed. + true if the editor’s value is valid; otherwise, false. + + + + Gets the editor type name. + + The ‘PopupContainerEdit‘ string always. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.PopupContainerForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets settings specific to the current object. + + An object containing settings specific to the current editor. + + + + Enables you to specify the textual representation of the editor’s value. + + + + + Fires before closing the popup window enabling you to modify the edit value. + + + + + Opens the popup window. + + + + + Contains values that specify how records are filtered within a grid lookup editor’s popup window. The selected mode is not in effect when the SearchMode property equals either AutoSearch or AutoSuggest. + + + + + Selects records that contain the specified sub-string. + A search for rows is performed against the column specified by the editor’s Properties.DisplayMember property (RepositoryItemLookUpEditBase.DisplayMember). + + + + + This option is equivalent to the StartsWith option for and controls in the following cases: + + 1) users cannot edit text in the text box (RepositoryItemLookUpEditBase.TextEditStyle is not set to Standard), + + 2) users can edit text in the text box and the control automatically completes the entered text (RepositoryItemGridLookUpEdit.AutoComplete or RepositoryItemTreeListLookUpEdit.AutoComplete is enabled). + + Otherwise, this option is equivalent to the Contains option for the and controls. + + This option is equivalent to the StartsWith option for the control. + + This option is equivalent to the Contains option for the control. Users can use the Find Panel to search for keywords. You can use the ColumnViewOptionsFind.FindFilterColumns property to specify grid columns in which to search for keywords. + + + + + Selects records whose field values start with the specified string. + A search for rows is performed against the column specified by the editor’s Properties.DisplayMember property (RepositoryItemLookUpEditBase.DisplayMember). + + + + + Contains settings that allow you to customize the behavior of a peek panel, assigned to the control. + + + + + Initializes a new instance of the class with the specified settings. + + A object that owns the newly created object. + + + + Copies all settings from the target object to this . + + A object whose property values should be copied to this . + + + + Gets or sets the display location for the assigned to this . + + A DevExpress.XtraEditors.TokenEditPopupPanelLocation enumerator value that is the display location for the assigned to this . + + + + Resets all properties to their default values. + + + + + Gets or sets which end-user actions cause the flyout panel to be displayed. + + A DevExpress.XtraEditors.TokenEditPopupPanelShowMode enumerator value that specifies which end-user actions cause the flyout panel to be displayed. + + + + Gets or sets whether the assigned to the editor’s RepositoryItemTokenEdit.PopupPanel property should be displayed. + + true if the assigned to the editor’s RepositoryItemTokenEdit.PopupPanel property should be displayed; otherwise, false. + + + + Serves as a base for progress bar controls. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the control’s background color. + + The control’s background color.$ + + + + Gets or sets whether this control can be focused using the TAB key. + + true if an end-user can focus the progress bar using the TAB key; otherwise, false. + + + + The control that indicates the progress of lengthy operations. + + + + + Creates a new object. + + + + + Decreases the progress bar’s position by a specified value. + + An integer value to be subtracted from the progress bar’s position. + + + + Gets the editor’s class name. + + The string value representing the editor’s class name. + + + + Gets or sets the value representing the progress bar’s current position. + + An object value representing the progress bar’s current position. + + + + Increases the progress bar’s current position by a specified value. + + An integer value to be added to the progress bar’s current position. + + + + Changes the progress bar’s position by the RepositoryItemProgressBar.Step property value. + + + + + Gets or sets the progress bar position. + + The progress bar’s current position. + + + + Occurs after the value of the ProgressBarControl.Position property has been changed. + + + + + Gets an object containing properties, methods and events specific to progress bar controls. + + A object containing progress bar settings. + + + + Gets or sets whether the progress is reflected in the application button in the Windows Task Bar. + + true if the progress is reflected in the application button in the Windows Task Bar; otherwise, false. + + + + For internal use. + + + + + Contains data for the SearchControl.QueryIsSearchColumn and RepositoryItemSearchControl.QueryIsSearchColumn events. + + + + + Initializes a new instance of the class. + + + + + Gets the processed column’s caption. + + A value that specifies a caption. + + + + Gets the processed field’s data type. + + An object that specifies the type of data. + + + + Gets the processed field’s name. + + A value that specifies tha field’s name. + + + + Gets or sets whether to search in the processed column. + + true to search in the processed column; otherwise, false. + + + + Combines multiple options (radio buttons) into a group that supports selecting one of several options. + + + + + Initializes a new control instance with default settings. + + + + + Gets or sets whether to automatically calculate the radio group’s size based on its contents. + + true to automatically calculate the radio group’s size based on its contents; otherwise, false. + + + + Gets or sets whether the editor’s width is changed to display the control’s first item in its entirety. This property is in effect when the editor resides within a . + + true if auto-size mode is enabled; otherwise, false. + + + + Gets the current editor’s type name. + + The ‘RadioGroup‘ string always. + + + + Returns the bounding rectangle of the first item’s text. + + The bounds of the first item’s text. + + + + Gets the boundaries of the specified item. + + A zero-based integer value which specifies the item’s index. + A structure which represents the specified item’s boundaries. + + + + Indicates whether a key should be processed by the editor or passed to its container control. + + A object specifying the key combination. + true if the key should be processed by the editor; otherwise, false + + + + Gets an object providing properties specific to a radio group editor. + + A object containing settings for the radio group editor. + + + + Gets or sets the selected item’s index. + + The selected item’s index in the RepositoryItemRadioGroup.Items collection; -1 if none selected. + + + + Occurs when changing the index of the selected value in the radio group editor. + + + + + Gets or sets the text label associated with a radio group editor. + + A value representing the text label associated with a radio group editor. + + + + Supports range selection for any data. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether ranges are selected using an animation effect. + + true if ranges are selected using an animation effect; false if animation is disabled. + + + + Gets or sets whether the current selection can be dragged within the Viewport (client area). + + true if the current selection can be dragged within the Viewport; otherwise, false. + + + + Gets or sets whether the range selection feature is enabled. + + true if range selection is enabled; otherwise, false. + + + + Gets or sets whether changing the selected range via the RangeControl.SelectedRange property visually updates the control using an animation effect. + + true if the control is updated using an animation effect when the RangeControl.SelectedRange property is changed; otherwise, false. + + + + Scrolls the control so that the selected range is moved to as near the control’s center as possible. + + true to scroll the control using an animation effect; otherwise, false. + + + + Gets or sets the object that visualizes its data within the RangeControl’s viewport. + + An object that visualizes its data within the RangeControl’s viewport. + + + + Provides access to range customization options exposed by the RangeControl.Client. + + Range customization options exposed by the RangeControl.Client. + + + + Gets or sets padding for the ‘s contents. + + The RangeControl‘s padding. + + + + Gets or sets whether the ‘s contents are faded when out of selected range. + + true if the out-of-range contents are faded; otherwise, false. + + + + Gets whether animation is in progress. + + true if animation is in progress; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the normalized selected range. + + A RangeControlNormalizedRange object that specifies the normalized selected range. + + + + Gets or sets the control’s orientation. + + A System.Windows.Forms.Orientation value. + + + + A DirectX-compatible method that replaces the standard Control.Paint method. + + + + + Fires when the selected range is changed. + + + + + Selects a range from the ‘s minimum bound to its maximum bound. + + + + + Gets or sets the selected range. + + A object that specifies the selected range’s bounds. + + + + Gets or sets whether the selection is performed via thumbs, flags or both. + + The RangeControlSelectionType value that specifies whether the selection is performed via thumbs, flags or both. + + + + Gets or sets whether the graduations and labels are displayed. + + true if the graduations and labels are displayed; otherwise, false. + + + + Gets or sets whether the Zoom&Scroll Bar is displayed. + + true if the Zoom&Scroll Bar is displayed; otherwise, false. + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for the Range Control. + + A DefaultBoolean enumerator value that specifies whether or not this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + Gets or sets the maximum scale(zoom) factor. + + A double value, greater than or equal to 1, that specifies the maximum scale factor. + + + + Gets the minimum width of the visible range relative to the data total range. + + A double value that is the minimum width of the visible range, in relative coordinates. + + + + Gets or sets the current scale (zoom) factor. + + A double value, greater than or equal to 1, that specifies the current scale factor. + + + + Gets or sets the start position of the visible range, in relative coordinates. + + A double value that is the start position of the visible range, in relative coordinates. + + + + Gets or sets the width of the visible range relative to the data total range. + + A double value that is the width of the visible range, in relative coordinates. + + + + The base class for objects that can be embedded into the . + + + + + Initializes a new instance of the class. + + + + + Gets or sets the format string used to format flag values. + + The format string used to format flag values. + + + + Gets or sets the string used to format ruler values. + + A string used to format ruler values. + + + + Gets or sets the parent for the current object. + + The parent object. + + + + Lists the values that specify the date-time measurement unit to which the chart’s gridlines and labels of the date-time chart client should be aligned. + + + + + Specifies a day as the date-time unit to which chart gridlines should be aligned. + + + + + Specifies an hour as the date-time unit to which chart grid lines should be aligned. + + + + + Specifies a millisecond as the date-time unit to which chart grid lines should be aligned. + + + + + Specifies a minute as the date-time unit to which chart grid lines should be aligned. + + + + + Specifies a month as the date-time unit to which chart grid lines should be aligned. + + + + + Specifies a second as the date-time unit to which chart gridlines should be aligned. + + + + + Specifies a week as the date-time unit to which chart grid lines should be aligned. + + + + + Specifies a year as the date-time unit to which chart grid lines should be aligned. + + + + + Lists the values that specify the time-span measurement unit to which the chart’s gridlines and labels of the time-span chart client should be aligned. + + + + + Specifies a day as the time-span unit to which chart gridlines should be aligned. + + + + + Specifies an hour as the time-span unit to which chart grid lines should be aligned. + + + + + Specifies a millisecond as the time-span unit to which chart grid lines should be aligned. + + + + + Specifies a minute as the time-span unit to which chart grid lines should be aligned. + + + + + Specifies a second as the time-span unit to which chart gridlines should be aligned. + + + + + The track bar with two sliders that allow a user to select a range of values. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether an end-user can drag the selected range with the mouse. + + true if a user can drag the selected range with the mouse; otherwise, false. + + + + Gets the editor’s class name. + + A string that represents the editor’s class name. + + + + Focuses the specified thumb. + + The thumb to focus. + + + + If the left slider has focus, this method moves the slider to the beginning of the track bar (). If the right thumb has focus, the method moves the slider to the left slider position. + + + + + If the right slider has focus, this method moves the slider to the end of the track bar (). If the left thumb has focus, the method moves the slider to the right slider position. + + + + + Gets an object which contains properties, methods and events specific to track bars. + + A object that contains range track bar settings. + + + + Gets or sets the editor’s value. + + A object that represents the editor’s value. + + + + Lists thumbs. + + + + + The thumb that ends the range. + + + + + The thumb that starts the range. + + + + + The control to rate specific content. + + + + + Initializes a new instance of the class with the default settings. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Occurs when the mouse pointer hovers over a rating scale item and allows you to display a unique hint for that item. + + + + + Returns the string value that names the ‘s type. + + Return value: RatingControl. + + + + Occurs when an end-user clicks a rating item in this . + + + + + Occurs when an end-user moves the mouse pointer away from the rating item area. + + + + + Fires when an end-user hovers over a rating item. + + + + + Provides access to the object that stores advanced settings. + + A object that stores advanced settings. + + + + Gets or sets the current rating. + + A Decimal value that is the current rating. + + + + Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. + + true, to display tooltips; otherwise, false. + + + + Gets or sets the text label for this . + + A String value that is the text label for this . + + + + Contains classes representing repository items that store editor-specific settings. + + + + + The base class for objects that contain properties for check editors. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether HTML tags can be used to format the text of the control’s items. + + true if HTML formatting is allowed; otherwise, false. + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Gets or sets a value specifying whether the editor’s width is calculated automatically to fit the editor’s content. + + true if the editor’s width is adjusted to fit the text width; otherwise, false. + + + + Gets or sets the style used to draw the check editor’s border. + + A enumeration value identifying the style used to draw the check editor’s border. + + + + Gets or sets the text label associated with a check editor. + + A System.String value representing the text label associated with a check editor. + + + + Gets or sets the horizontal alignment of the checkbox and text. + + A value that specifies the horizontal alignment of the checkbox and text. + + + + Gets the class name of the edit control corresponding to the current repository item. + + A System.String object identifying the class name of the corresponding editor. + + + + Gets or sets a value indicating whether a focus rectangle is drawn round the entire client region or around the caption text only. + + true if a focus rectangle is around the entire client region; otherwise, false. + + + + Gets or sets the horizontal alignment of a check box glyph within a check editor. + + A DevExpress.Utils.HorzAlignment enumeration value specifying the check box’s horizontal alignment. + + + + Gets or sets the vertical alignment of a check box glyph within a check editor. + + A enumeration value specifying the check box’s vertical alignment. + + + + Gets or sets whether the check box is aligned at the center, top or bottom of the control. + + A enumeration value specifying the check box’s vertical alignment. + + + + Gets a value indicating whether the check editor functions like a radio button. + + true if the check editor represents a radio button; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Contains appearance settings for the calendar visual elements in different states. + + + + + Initializes a new instance of the class with specified settings. + + The object that owns these appearance settings. + + + + Specifies the Today, Clear, Ok, and Cancel button appearance settings in the normal state. + + An object that contains appearance settings. + + + + Specifies the Today, Clear, Ok, and Cancel button appearance settings when the mouse pointer hovers over them. + + An object that contains appearance settings. + + + + Specifies the Today, Clear, Ok, and Cancel button appearance settings when they are pressed. + + An object that contains appearance settings. + + + + Specifies the appearance of month headers if the calendar displays multiple months. + + An object that contains appearance settings. + + + + Specifies the appearance of day cells in the normal state. + + An object that contains appearance settings. + + + + Specifies the appearance of day cells in the disabled state. + + An object that contains appearance settings. + + + + Specifies the appearance of day cells when the mouse pointer hovers over them. + + An object that contains appearance settings. + + + + Specifies the appearance of holiday cells. + + An object that contains appearance settings. + + + + Specifies the appearance of day cells that do not belong to the current month. + + An object that contains appearance settings. + + + + Specifies the appearance of day cells in the pressed state. + + An object that contains appearance settings. + + + + Specifies the appearance of selected day cells. + + An object that contains appearance settings. + + + + Specifies the appearance of “special” day cells in the normal state. + + An object that contains appearance settings. + + + + Specifies the appearance of “special” day cells in the disabled state. + + An object that contains appearance settings. + + + + Specifies the appearance of “special” day cells when the mouse pointer hovers over them. + + An object that contains appearance settings. + + + + Specifies the appearance of “special” day cells that do not belong to the current month. + + An object that contains appearance settings. + + + + Specifies the appearance of “special” day cells in the pressed state. + + An object that contains appearance settings. + + + + Specifies the appearance of selected “special” day cells. + + An object that contains appearance settings. + + + + Specifies the “today” cell’s appearance settings. + + An object that contains appearance settings. + + + + Specifies the header appearance settings in the normal state. Use to specify the header visibility. + + An object that contains appearance settings. + + + + Specifies the header appearance settings when the mouse pointer hovers over it. These settings do not combine with settings in the normal state. + + An object that contains appearance settings. + + + + Specifies the header appearance settings when it is pressed. These settings do not combine with settings in the normal state. + + An object that contains appearance settings. + + + + Gets whether the owner control is being initialized. + + true if the owner control is being initialized; otherwise, false. + + + + Gets the owner control. + + An object that specifies the owner control. + + + + Specifies the week day abbreviation appearance settings. + + An object that contains appearance settings. + + + + Specifies the week number appearance settings. + + An object that contains appearance settings. + + + + Lists selection modes available for the end-user. + + + + + Multiple dates can be selected. + + + + + End-user is allowed to select a single date only. + + + + + Contains values that enumerate a Calendar Control’s display modes. + + + + + The classic calendar: + + + + + + An Outlook 2016-inspired calendar style. + + + + + + The appearance of the calendar is dependent on the current OS. + + + + + The calendar that supports the Acrylic and Reveal Highlight effects and allows you to mirror the appearance of the Windows 10 calendar. + + + + + + The touch-aware date-editing UI: + + For a control, the control’s mask (see the RepositoryItemTextEdit.Mask inherited property) specifies which date-time columns are displayed in the dropdown calendar. + To display time columns, enable the RepositoryItemDateEdit.CalendarTimeEditing option. + + + + + The Vista-style calendar: + + + + + + Implements the basic functionality of the component. + + + + + Creates a new object with default settings. + + + + + Fires immediately after the repository item collection has been changed. + + + + + Provides access to the collection of repository items stored by the repository. + + A object + + + + Fires when changing repository item properties residing within the repository. + + + + + Enumerates values that specify the type of an editor’s property value. + + + + + A object that contains the string representations of the selected item values, separated by a comma (or a custom character) and a space character. + + + + + A object that contains the selected item values. + + + + + Contains values that specify whether an editor’s edit value or display text is exported, when the editor’s data is exported in XLS and CSV formats. + + + + + Either an editor’s value or display text is exported, depending on the editor’s type. For the ImageComboBoxEdit and LookUpEdit controls, their display text is exported. For other editors, their edit values (BaseEdit.EditValue), which sometimes match the display text, are exported. + + + + + An editor’s display text is exported. + + + + + An editor’s edit value is exported. + + + + + Contains values that specify the type of the editor’s property value. + + + + + A object that contains property values of selected items separated by the followed by the space character. + Enables the multiple item selection. + + + + + ValueList if the editor’s property is specified. + Value in other cases. + + + + + An object from the editor’s . + + + + + A List<object> object that contains selected items. + Enables the multiple item selection. + + + + + Stores repository items to be shared between container controls and components (, , , , etc). + + + + + Creates a new class instance. + + + + + Creates a new class instance. + + The owner which creates the persistent repository. + + + + Initializes a new instance of the class. + + An object which implements the interface. + + + + Provides access to the collection of repository items stored in the repository. + + A object that contains a collection of repository items. + + + + This method supports the internal infrastructure and is not intended to be called directly from your code. + + + + + Contains data for the RatingControl.BeforeShowToolTip and RepositoryItemRatingControl.BeforeShowToolTip events. + + + + + Initializes a new instance of the class with specified settings. + + For internal use. + For internal use. + + + + Gets information about the hit point. + + An object that contains information about the hit point. + + + + Gets or sets tooltip content. + + A value that specifies tooltip content. + + + + Gets the rating value. + + A rating value. + + + + Serves as the base for all repository items. + + + + + Creates a new object. + + + + + Gets or sets the default action description of the repository item for use by accessibility client applications. + + A string which specifies the default action description of the repository item for use by accessibility client applications. + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + Gets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. + + true if the focus rectangle is displayed when the editor has focus; otherwise, false. + + + + Gets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. + + true if the appearance settings used to paint the editor when it’s focused can be used; otherwise, false. + + + + Gets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. + + A value that specifies whether HTML tags can be used to format an editor’s text or text of the editor’s items. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. + + true if scrolling via the Mouse Wheel is supported by the editor; otherwise, false. + + + + Gets the appearance settings used to paint the editor when it’s enabled. + + A object which provides the appearance setting used to paint the editor when it’s enabled. + + + + Gets the appearance settings used to paint the editor when it’s disabled. + + A object which provides the appearance setting used to paint the editor when it’s disabled. + + + + Gets the appearance settings used to paint the current editor when it’s focused. + + A object which provides the appearance setting used to paint the editor when it’s focused. + + + + Gets the appearance settings used to paint the read-only editor. + + A object which provides the appearance settings used to paint the read-only editor. + + + + Copies settings from the repository item specified as a parameter. + + A object whose settings are to be copied to the current object. + + + + Gets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content. + + true if the editor’s height is calculated automatically to fit the editor’s content; otherwise, false. + + + + Notifies the editor that the initialization has been started. + + + + + Locks the object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. + + + + + Gets or sets the editor’s best fit width. + + An integer value that specifies the editor’s best fit width, in pixels. + + + + Gets or sets the editor’s border style. + + A enumeration value specifying the editor’s border style. + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Fires when clicking the editor. + + + + + Creates a copy of the current repository item. + + A object (or its descendant) that is a copy of the current item. + + + + Connects the repository item to the specified object. + + An object representing the control to which the current repository item is connected. + + + + Gets or sets the context menu for the editor. + + A object representing the context menu for the editor. + + + + Creates an editor whose type corresponds to the repository item’s type. + + A descendant representing the editor whose type corresponds to this repository item’s type. + + + + Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. + + A DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter object used to paint the group rows in the XtraGrid. + + + + This member supports the editor library’s internal infrastructure and is not intended to be used in your applications. + + A DevExpress.XtraEditors.Drawing.BaseEditPainter descendant used to paint the editor. + + + + This member supports the editors library’s internal infrastructure and is not intended to be used in your applications. + + A DevExpress.XtraEditors.ViewInfo.BaseEditViewInfo descendant containing the editor’s view information. + + + + Enables custom display text to be provided for an editor. + + + + + Gets the default horizontal alignment of the editor’s content. + + A enumeration value specifying the editor content’s default horizontal alignment. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Removes the connection between the repository item and the specified object. + + An object representing the control from which the repository item is disconnected. + + + + Provides access to the format settings applied to the editor’s display text. These settings are in effect when the editor does not have input focus. + + A object containing the formatting settings applied to the control’s display text. + + + + Fires when the editor is double clicked. + + + + + Fires when an object is dropped onto the editor. + + + + + Fires when a dragged object enters the editor’s area. + + + + + Fires when a dragged object leaves the editor’s area. + + + + + Fires repeatedly when dragging an object over the editor. + + + + + Gets whether the editor’s value can be changed. + + Always true. + + + + Provides access to the settings used to format the edit value when the editor has input focus. + + A object containing the formatting settings applied to the edited value when the editor has input focus. + + + + Gets the class name of the editor corresponding to the repository item. + + A string value representing the class name of the editor. + + + + Fires when the editor’s BaseEdit.EditValue property changes. + + + + + Gets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. + + An integer value which specifies the time interval in milliseconds. + + + + Gets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. + + An integer value which specifies the time interval in milliseconds. + + + + Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. + + An enumeration member which specifies when the editor’s RepositoryItem.EditValueChanged event should occur. + + + + Fires when the editor’s value is about to be changed. + + + + + Gets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. + + true if the editor can respond to user actions; otherwise, false. + + + + Notifies the editor that the initialization has been completed. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Fires when the editor receives focus. + + + + + Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. + + A enumeration value. + + + + Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Returns the text representation of the specified value formatted using the editor’s settings. + + An object representing the value to be formatted. + A string value representing the formatted textual representation of the value specified. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + An object that specifies the type of the current editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns a hash code. + + The hash code for the current object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Enables you to specify the cursor appearance when dragging this editor’s data. + + + + + Fires when the end-user requests help for the editor. + + + + + Gets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + Indicates whether a particular key can activate the editor used as an inplace control. + + A System.Windows.Forms.Keys enumeration value (or a bitwise combination) specifying the key combination to process. + true if the key can activate the editor; otherwise, false. + + + + Indicates whether the editor is currently in design mode. + + true if the editor is in design mode; otherwise, false. + + + + Gets a value indicating whether the control has been disposed of. + + Gets a value indicating whether the control has been disposed of. + + + + Gets whether the event is postponed. + + true if the event is postponed; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Indicates whether the editor is being loaded. + + true if the editor is being loaded, otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets a value indicating whether the editor is immediately updated in response to changing its settings. + + true if the editor cannot be updated until unlocked; otherwise, false. + + + + Indicates whether the key is handled by the editor or the container control. + + A object specifying the key to process. + true if the key will be processed by the editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when a key is pressed while the editor has focus. + + + + + Fires when a character key is pressed while the editor has focus. + + + + + Fires when a key is released while the editor has focus. + + + + + Fires when the editor loses focus. + + + + + Gets the number of objects connected to the current repository item. + + An integer value representing the number of repository item connections. + + + + This method supports the .NET framework infrastructure and is not intended to be called from your code. + + + + + Provides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. + + A object that contains the editor’s look and feel settings. + + + + Fires when the edit value is first changed since it was last validated. + + + + + Fires when a mouse button is pressed while the mouse pointer is over the editor. + + + + + Fires when the mouse pointer enters the editor’s area. + + + + + Fires when hot-tracking an editor element. + + + + + Fires when the mouse pointer leaves the editor’s area. + + + + + Fires when the mouse pointer moves over the editor’s area. + + + + + Fires when the mouse button is released while the mouse pointer is over the editor. + + + + + Fires when the mouse wheel moves while the mouse pointer is within the editor. + + + + + Gets or sets the repository item name. + + A string value representing the repository item name. + + + + Set the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the control. + + + + + Gets or sets the text that presents the editor’s null value (null, System.DBNull.Value and RepositoryItemDateEdit.NullDate - for ). + + The string displayed in the edit box when the edit value equals null, System.DBNull.Value or RepositoryItemDateEdit.NullDate (for controls). + + + + Gets the editor that owns the repository item. + + A descendant that owns the repository item. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Converts an input value (entered by a user or assigned in code) to the value that the editor will store. + + + + + Gets or sets the popup window’s location. + + A structure which specifies the location of the editor’s popup window. + + + + Gets an object providing properties specific to all editors that can be used inplace within a container control. + + A object providing settings common to all editors that can be used inplace, i.e. not standalone. + + + + Fires immediately after a change to one of the editor’s properties. + + + + + Fires when the help is provided to accessibility applications. + + + + + Fires when dragging the editor’s data allowing you to specify whether dragging should be continued. + + + + + Provides the capability to specify whether the key pressed in the editor is processed by the editor or a container control (, , etc.) that displays this editor. + + + + + Gets or sets a value specifying whether the editor’s value can be changed by end-users. + + true if end-users can not modify editor’s value; otherwise, false. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + false always. + + + + This member supports the .NET Framework infrastructure and is not intended to be used in your applications. + + + + + Updates the according to current scale settings. This method is called automatically when the form’s runtime DPI settings differ from those in design-time. + + An object with the scale properties. + + + + Gets or sets a for the object. + + A for the object. + + + + For internal use. + + + + + Gets or sets the data associated with the repository item. + + An object that contains the information which is associated with the repository item. + + + + Returns a string that represents the current object. + + A value which represents the repository item. + + + + This method supports the .NET framework infrastructure and is not intended to be called from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets whether to substitute this editor with the single-line text editor in auto-filter rows. + + Always false. + + + + Allows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled. + + + + + Serves as the base for repository items that provide settings for editors that represent a progress bar. + + + + + Initializes a new instance of the class. + + + + + Copies settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Gets or sets a value specifying whether the progress bar’s height is changed according to the size of its contents. + + true if the progress bar’s height is automatically changed to fit the size of its contents; otherwise false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the indicator’s end color. + + A object that represents the end color of the gradient fill. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the maximum height of the progress block. + + An integer value that specifies the maximum height of the progress block. + + + + Gets or sets a value that specifies the direction of the progress indicator. + + A enumeration value that specifies the direction of the progress indicator. + + + + Gets or sets the amount of space around the progress block. + + A System.Windows.Forms.Padding structure that specifies the amount of space around the progress block. + + + + Gets or sets the progress indicator paint style. + + The progress indicator paint style. + + + + Gets an object that provides properties specific to the progress bar. + + A object that provides settings specific to the progress bar. + + + + Gets or sets whether the control displays the textual representation of the progress bar’s current position. + + true, to display the text; otherwise, false. + + + + Gets or sets the indicator’s starting color. + + A object that represents the starting color for gradient fill. + + + + Gets or sets the orientation of the text within the ProgressBar control. + + A value that specifies the orientation of the text within the ProgressBar control. + + + + Represents the class which provides settings common to all spin editors. + + + + + Creates a new object. + + + + + Gets or sets the index of a button within the button collection which will open the editor’s dropdown window. + + An Int32 value specifying the index of a button within the button collection which will open the editor’s dropdown window. The default is 0. + + + + This property is not supported in descendants, except for the object. See RepositoryItemTimeEdit.AllowDropDownWhenReadOnly, to learn more. + + + + + Gets the appearance settings used to paint the editor’s popup window. + + Appearance settings used to paint the editor’s dropdown window. + + + + Copies settings of the specified repository item. + + A object representing the source of the operation. + + + + Occurs when the ‘s pop-up window is completely closed. + + + + + Occurs when the editor’s pop-up window starts closing. + + + + + Gets or sets the key combination used to open and close the ‘s pop-up window. + + A object specifying the key combination used to open and close the ‘s pop-up window. + + + + Gets the class name of an editor corresponding to the current repository item. + + A string value representing the class name of a corresponding editor. + + + + Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. + + An enumeration member which specifies when the editor’s RepositoryItem.EditValueChanged event should be raised. + + + + Occurs after the editor’s popup window has been opened. + + + + + This member is not supported. + + A enumeration value specifying the border style of the editor’s popup window. + + + + Gets or sets the minimum size of the editor’s dropdown window. + + A structure that specifies the dropdown window’s minimum size. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Gets an object providing properties specific to the spin edit control. + + A object representing settings specific to the spin edit control. + + + + Enables you to specify whether an attempt to close the editor’s popup window will succeed. + + + + + Enables you to specify whether an attempt to open the editor’s popup window will succeed. + + + + + Gets or sets whether the popup window can be opened by clicking the edit box and whether a single or double click is required. + + A value that specifies whether the ‘s pop-up window can be invoked by clicking the edit box. + + + + Gets or sets whether the shadow is displayed for the editor’s dropdown window. + + true, to display the shadow for the editor’s dropdown window; otherwise, false. + + + + Gets or sets a value specifying which editor button is the spin button used to increment or decrement the edited value. + + An integer value representing the spin button’s zero-based index. + + + + Gets or sets whether spin buttons are oriented vertically or horizontally. + + A enumeration value that specifies whether spin buttons are oriented vertically or horizontally. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Not supported. + + Returns always true + + + + Serves as the base for repository items corresponding to BLOB editors. + + + + + Initializes a new class instance with default settings. + + + + + Gets whether it is allowed to update popup width. + + true if it is allowed to update popup width; otherwise, false. + + + + Copies settings of the specified repository item to the current one. + + A object representing the source of the operation. + + + + Gets the editor content’s default horizontal alignment. + + The HorzAlignment.Near value always. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Gets or sets the source of images used to indicate whether the editor contains data. + + An object which represents the source of images that indicate whether a BLOB editor contains data. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Provides access to the editor’s mask settings. + + A object which contains the editor’s mask settings. + + + + Allows you to hide the default OK and Cancel buttons shown in popup menus of class descendants. + + + + + Gets or sets a value specifying whether the editor’s popup window is sizeable. + + true if the editor’s popup window is sizeable; otherwise, false. + + + + Gets or sets the size the editor’s popup window should have when first opened. + + A structure representing the size of the popup window on its first occurrence. + + + + Gets or sets whether the initial popup width matches the editor or content width. + + A DevExpress.XtraEditors.PopupWidthMode enumeration value, such as ContentWidth or UseEditorWidth, that specifies whether the initial popup width matches the editor or content width. + + + + Gets an object providing properties specific to a BLOB editor. + + A object instance providing settings common to a BLOB editor. + + + + Gets or sets a value specifying whether an identification icon is displayed within the editor’s edit region. + + true if a BLOB editor displays an identification icon; otherwise, false. + + + + Gets or sets the style in which text is displayed in the BLOB editor’s edit box. + + A enumeration value determining editing style. + + + + For internal use. + + A Boolean value. + + + + Contains settings specific to a control. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether the can enter the Edit mode. If this setting is disabled, the control operates solely in Select mode. + + true if the can enter the Edit mode; otherwise, false. + + + + For internal use. + + A Boolean value. + + + + Copies all settings from the target to this object. + + A object whose settings are to be copied to this object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the current mode. + + A enumerator value that specifies the current mode. + + + + Gets whether the RepositoryItemBreadCrumbEdit.GoBack method will take effect if called. + + true if the RepositoryItemBreadCrumbEdit.GoBack method will take effect if called; otherwise, false. + + + + Gets whether the RepositoryItemBreadCrumbEdit.GoForward method will take effect if called. + + true if the RepositoryItemBreadCrumbEdit.GoForward method will take effect if called; otherwise, false. + + + + Gets whether the RepositoryItemBreadCrumbEdit.GoUp method will take effect if used at the moment. + + true if the RepositoryItemBreadCrumbEdit.GoUp method will take effect if used at the moment; otherwise, false. + + + + Gets or sets whether or not navigating to nodes within this Breadcrumb Edit Control requires an exact node caption match, including the letter cases. + + true, navigating to nodes within this Breadcrumb Edit Control requires an exact node caption match; otherwise, false. + + + + Returns the \ character that is the default path separator for a control. + + + + + Returns the editor type name. + + Return value: BreadCrumbEdit. + + + + Returns a collection that contains all nodes owned by this . + + A ReadOnlyCollection that stores all s owned by this . + + + + Gets the object that stores the complete navigation history for this . + + A BreadCrumbHistory object that stores the complete navigation history for this . + + + + Gets the position within a collection occupied by the currently used . + + An Int32 value that is the position within a collection occupied by the currently used . + + + + Navigates to the previous within the collection. + + + + + Navigates to the next object within the collection. + + + + + Navigates to the currently selected node’s parent node. + + + + + Occurs whenever a node’s drop-down list is hidden. + + + + + Provides access to a object that stores the navigation history for this . + + A object that stores the navigation history for this . + + + + Gets or sets the position of an image within the RepositoryItemBreadCrumbEdit.Images collection that should serve as the default glyph for all non-root nodes. + + An Int32 value that is the position of an image within the RepositoryItemBreadCrumbEdit.Images collection that should serve as the default glyph for all non-root nodes. + + + + Gets or sets the image collection assigned to this . + + An Object that is the image collection assigned to this . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Occurs each time a new node is about to be added to the . + + + + + Occurs whenever a node owned by this changes. + + + + + Fires when a node from this ‘s RepositoryItemBreadCrumbEdit.Nodes collection is clicked. + + + + + Occurs whenever an end-user clicks any node drop-down button within this . + + + + + Gets or sets the maximum row number a node’s drop-down list can occupy. + + An Int32 value that is the maximum row number a node’s drop-down list can occupy. + + + + Provides access to all nodes owned by this control. + + A BreadCrumbNodeCollection that stores nodes owned by this control. + + + + Gets the editor that owns this . + + A that owns this . + + + + Gets or sets the nodes sequence currently visible within this . + + A String value that is the nodes sequence currently visible within this . + + + + Occurs whenever a ‘s path was changed. + + + + + Occurs when a path to which the was about to navigate does not pass validation. + + + + + Gets or sets the character used to separate node values in a path string. + + A String value that is the character used to separate node values in a path string. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Occurs when the editor needs to navigate to a dynamically populated node for the first time. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Resets the history of end-user navigation within this control. + + + + + Gets or sets the image used by this ‘s root node. + + An Image that is this ‘s root node glyph. + + + + Fires when the root node’s glyph is clicked. + + + + + Gets or sets the index of an image within the RepositoryItemBreadCrumbEdit.Images collection that should be used as a root node glyph. + + An Int32 value that is the index of an image within the RepositoryItemBreadCrumbEdit.Images collection that should be used as a root node glyph. + + + + Gets or sets the last currently selected in this . + + A object that is the last node currently selected in this . + + + + Fires when this ‘s RepositoryItemBreadCrumbEdit.SelectedNode changes. + + + + + Occurs each time an end-user clicks empty space within this . + + + + + Sets a with the target index as the current history item. + + An Int32 value that is the specific ‘s position within a parent collection. + + + + Occurs after a node drop-down is shown completely. + + + + + Gets or sets whether the root glyph should be displayed. + + true if the root glyph should be displayed; otherwise, false. + + + + Fires when the User Action Menu is about to be displayed. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether or not all visible nodes in the ‘s drop-down menu nodes should be sorted by their captions. + + true if nodes should be sorted by their captions; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + For internal use. + + + + + Occurs each time the has to navigate to an unknown node. + + + + + An object that contains settings specific to a control. Repository items allow you to embed editors into container controls (for instance, , , ). + + + + + Initializes a new class instance with default settings. + + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Performs specific actions before control initialization. + + + + + Occurs when an editor button is clicked. + + + + + Occurs when an edit button is pressed within a button editor. + + + + + Returns the collection of buttons in the current button editor. + + The object providing access to buttons for the button editor. + + + + This member is not supported. + + The value identifying the style to draw editor buttons. + + + + Gets or sets the style used to draw editor buttons. + + A enumeration value identifying the style to draw editor buttons. + + + + Creates a default button in the button collection. + + + + + Allows you to apply custom painting to specific ‘s buttons. + + + + + Returns the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Returns an editor which owns the current repository item object. + + A control owning the current repository item. + + + + Returns an object providing properties specific to the button edit control. + + The object providing settings common to the current edit control. + + + + Gets or sets whether the RepositoryItemButtonEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a and . + + true if the RepositoryItemButtonEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a and ; otherwise, false. + + + + Gets or sets the style in which text is displayed and edited in the button editor. + + The value determining the editing style. + + + + Gets whether to substitute this editor with the single-line text editor in auto-filter rows. + + Always true. + + + + Represents a class which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Gets the default alignment of the editor’s contents when the editor operates as an inplace control. + + The HorzAlignment.Far value. + + + + Gets or sets an edit mask + + A string which specifies a mask expression. + + + + Returns the class name of the edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Returns the editor which owns the current repository item object. + + A control owning the current repository item. + + + + This property is not supported by the class. + + The Size.Empty value. + + + + Gets or sets the maximum number of digits displayed to the right of the decimal point when the dropdown is open. + + The maximum number of digits displayed in the fractional part of the value. + + + + Gets an object providing properties specific to the calc edit control. + + The object providing settings for the calc edit control. + + + + Gets or sets the value indicating whether the close button should be displayed in the dropdown window. + + true if the close button is displayed in the dropdown; otherwise false. + + + + Occurs after the value of the CalcEdit.Value property has been changed. + + + + + Represents the class which stores settings specific to the control. + + + + + Initializes a new instance of the class. + + + + + Adds new items that represent elements of the specified enumeration to the editor drop-down, allowing you to specify whether enumeration constant names or integer values are assigned to the item values. + + The type of the required enumeration. + true if enumeration underlying integer values are assigned to the item values; otherwise, false. + + + + Adds new items that represent elements of the specified enumeration to the editor drop-down. + + The type of the required enumeration. + + + + Adds new items that represent elements of the specified enumeration to the editor drop-down. + + + + + Adds new items that represent elements of the specified enumeration to the control. Allows you to customize item descriptions and specify whether underlying integer values are assigned to the item values. + + A System.Converter delegate that generates item descriptions to be displayed. + true, if values for generated items should store numeric enumerator values; false, if these values should store constant enumerator names instead. + The type of the required enumeration. + + + + Adds new items that represent elements of the specified enumeration to the editor drop-down, allowing you to customize item descriptions. + + A System.Converter delegate that generates item display captions. + + + + Gets or sets whether HTML tags can be used to format the text of the control’s items. + + A value that specifies whether HTML tags can be used to format the text of the control’s items. + + + + Gets or sets whether multiple items can be selected simultaneously in the dropdown. + + true if multiple items can be selected simultaneously in the dropdown; otherwise, false. + + + + Gets whether it is allowed to update popup width. + + true if it is allowed to update popup width; otherwise, false. + + + + Copies settings from the specified object to the current object, allowing you to select whether data-related settings should be copied. + + A source repository item object. + true to copy data-related settings; otherwise, false. + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Forcibly nullifies the internal data adapter. Call this method before you dynamically provide a data source for the current repository item within a ShownEditor event handler. + + + + + Provides access to the settings applied to the context buttons displayed by the editor items. + + A DevExpress.Utils.SimpleContextItemCollectionOptions object that comprises settings applied to the context buttons displayed by the editor items. + + + + Provides access to the collection of context buttons displayed by editor items. + + A ContextItemCollection object that represents the collection of context buttons. + + + + Enables you to sort items in custom order. + + + + + Gets or sets the data source whose items are displayed in the control’s dropdown. + + A data source whose items are displayed in the control’s dropdown. + + + + Fires when assigning a new object to the RepositoryItemCheckedComboBoxEdit.DataSource property. + + + + + Gets or sets a field name in the bound data source whose contents are to be displayed by the control’s check items. + + A string value specifying a field name in a data source. + + + + Fires when assigning a new value to the RepositoryItemCheckedComboBoxEdit.DisplayMember property. + + + + + Allows you to manually paint items. + + + + + Gets or sets the number of visible items in the dropdown window. + + An integer that specifies the number of visible items in the dropdown window. + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Gets or sets whether the editor’s property returns a object that contains the selected item values or a object that contains the string representations of these values, separated by a comma (or a custom character) and a space character. + + An enumeration value that specifies the type of the property value. + + + + Gets or sets whether the check states of check items in the dropdown are automatically changed according to the new edit value. + + A value that specifies check item synchronization mode. + + + + Returns values of all currently checked items. + + A object that stores values of all currently checked items. + + + + Returns an object that specifies checked items. + + An object that specifies the edit value. + An object that specifies checked items. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Enables you to disable specific items. + + + + + Returns items from the RepositoryItemCheckedComboBoxEdit.Items collection. + In bound mode, this method populates the item collection before returning it. + + A object that contains items. + + + + Gets or sets the paint mode for the selected and hot-tracked items in the CheckedListBoxControl embedded in the dropdown window. + + A value that specifies the paint mode for the selected and hot-tracked items. + + + + Gets or sets whether item hot-tracking is enabled in the CheckedListBoxControl embedded in the dropdown window. + + true if the item hot-tracking is enabled; otherwise, false. + + + + Gets or sets how items in the embedded CheckedListBoxControl are selected when item hot-tracking is enabled. + + A value that specifies how items are selected. + + + + Gets or sets whether the incremental search feature is enabled. + + true if the incremental search feature is enabled; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the height of items in the drop-down is automatically calculated to fit their entire content. + + true if item height is automatically calculated; otherwise, false. + + + + Fires after an item’s check state was changed. + + + + + Fires before an item’s check state changes and allows you to cancel the action. + + + + + Gets the collection of check items to be displayed in the dropdown. + + A collection. + + + + Gets or sets the maximum length of the text that can be displayed in the editor. This property is only in effect for in-place editors. + + An integer value that specifies the maximum length of the text that can be displayed in the editor. + + + + This property is not supported by the class. + + + + + Provides the capability to change the height of an individual item. + + + + + Gets or sets the control to display in the popup window. This member is not supported by the class. + + A object. + + + + This event is not supported by the class. + + + + + This event is not supported by the class. + + + + + Updates the editor to reflect changes made to a data source. + + + + + Gets whether the RepositoryItemPopupContainerEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a and . + + true if the RepositoryItemPopupContainerEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a and ; otherwise, false. + + + + Gets or sets whether the ‘Select All’ check item is visible. + + A string that specifies the ‘Select All’ item’s caption. + + + + Gets or sets whether the ‘Select All’ check item is visible. + + true if the ‘Select All’ item is visible; otherwise, false. + + + + Gets or sets the character separating checked items in the edit value, and the resultant text displayed in the edit box. + + A separator character. + + + + Creates items in the dropdown to represent elements of the specified set of flags. + + A object that specifies the enumeration type representing a bit field (set of flags). + + + + Gets or sets the ‘Select All’ check item’s caption. + + A string that specifies the ‘Select All’ item’s caption. + + + + Gets or sets whether the ‘Select All’ check item is visible. + + true if the ‘Select All’ item is visible; otherwise, false. + + + + Gets or sets whether the OK and Cancel buttons in the dropdown are visible. + + true if the OK and Cancel buttons in the dropdown are visible; otherwise, false. + + + + Gets or sets whether tooltips are displayed for dropdown items whose text is trimmed. + + A value that specifies whether tooltips are displayed for items whose text is trimmed. + + + + Gets or sets the sort order. + + A SortOrder enumeration member that specifies the order. + + + + Gets or sets whether changing a CheckedComboBoxEdit control’s edit value updates the check states of the control’s items. + + true if the editor’s edit value and items in the dropdown are in sync; otherwise, false. + + + + Gets or sets the field name in the bound data source whose contents are assigned to item values. + + A string value specifying a field name in the data source. + + + + Fires when assigning a new value to the RepositoryItemCheckedComboBoxEdit.ValueMember property. + + + + + Represents a repository item which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets whether the check editor supports three check states (‘Unchecked’, ‘Checked’ and ‘Indeterminate’) instead of two (‘Unchecked’ and ‘Checked’). + + true if the supports three check states; false if the editor only supports two check states. + + + + Copies the settings of a specific repository item to the current one. + + A object representing the source of the operation. + + + + Gets or sets the caption of the current . + + A String value that is the caption of the current . + + + + Provides access to options specific to the check box glyph (style, color, size). + + A DevExpress.XtraEditors.CheckBoxOptions object that comprises options specific to the check box glyph (style, color, size). + + + + Fires after the CheckEdit.Checked property has been changed. + + + + + Fires after the CheckEdit.CheckState property has been changed. + + + + + Gets or sets what the checkbox looks like. + + A enumeration value specifying what the check box looks like. + + + + Gets or sets the text representation of the RepositoryItemCheckEdit.ValueChecked value. + + A string that specifies the text representation of the RepositoryItemCheckEdit.ValueChecked value. + + + + Gets or sets the text representation of the RepositoryItemCheckEdit.ValueGrayed value. + + A string that specifies the text representation of the RepositoryItemCheckEdit.ValueGrayed value. + + + + Gets or sets the text representation of the RepositoryItemCheckEdit.ValueUnchecked value. + + A string that specifies the text representation of the RepositoryItemCheckEdit.ValueUnchecked value. + + + + Gets the class name of the edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Converts the value passed as a parameter to the appropriate check state. + + A expression (typically, the edited value) to be converted to the appropriate check state. + A enumeration value representing the check state to be set. + + + + Converts the check state value passed as a parameter to the appropriate edit value. + + A enumeration value representing the check state to be converted to the appropriate edited value. + A expression representing the edited value to be set for a check editor. + + + + Gets or sets whether the read only is highlighted when hovered over with the mouse cursor. + + true if the read only changes its appearance when hovered over with the mouse cursor; otherwise, false. + + + + Occurs when a hyperlink within the current control’s caption is clicked. + + + + + Gets or sets the index of an image in the images collection for the checked state of the check box. + + An integer value that specifies the zero-based index of an image in the images collection for the checked state of the check box. + + + + Gets or sets the index of an image in the images collection for the indeterminate state of the check box. + + An integer value that specifies the zero-based index of an image in the images collection for the indeterminate state of the check box. + + + + Gets or sets the index of an image in the images collection for the unchecked state of the check box. + + An integer value that specifies the zero-based index of an image in the images collection for the unchecked state of the check box. + + + + Provides access to options specifying vector or raster glyphs for the check box in the checked, unchecked and indeterminate states. + + A DevExpress.Utils.Drawing.CheckImageOptions object that comprises options specifying vector or raster glyphs for the check box in the checked, unchecked and indeterminate states. + + + + Gets or sets the collection of images that specify the unchecked, checked and indeterminate states of the check box. + + An object that represents the collection of images that specify the unchecked, checked and indeterminate states of the check box. + + + + Gets a value indicating whether the check editor functions like a radio button. + + true if the check editor represents a radio button; otherwise, false. + + + + Gets or sets the check box paint style applied when the editor’s check state is Indeterminate. + + The check box paint style in the Indeterminate check state. + + + + Gets or sets the image for the checked state of the check box. + + A object that specifies the image displayed instead of the default check box in the checked state. + + + + Gets or sets the image for the indeterminate state of the check box. + + A object that specifies the image displayed instead of the default check box in the indeterminate state. + + + + Gets or sets the image for the unchecked state of the check box. + + A object that specifies the image displayed instead of the default check box in the unchecked state. + + + + Gets an object providing properties specific to a check edit control. + + A object instance providing settings specific to a check edit control. + + + + Allows for custom conversion from the edit value to a check state (checked, unchecked and indeterminate). + + + + + Allows for custom conversion from the check state (checked, unchecked and indeterminate) to an edit value. + + + + + Gets or sets the index of a logical radio group to which the check editor belongs. + + An integer value specifying the non-negative index of a logical radio group owning the check editor. + + + + Gets or sets a value that corresponds to the checked state. + + The value associated with the checked state. + + + + Gets or sets a value that corresponds to the indeterminate state. + + The value associated with the indeterminate state. + + + + Gets or sets a value that corresponds to the unchecked state. + + The value associated with the unchecked state. + + + + Represents a collection of repository items. + + + + + Initializes a new instance of the class with the specified owner. + + An object that is the owner of the created collection. + + + + Adds the specified repository item to the end of the collection. + + A descendant to be added to the collection. + An integer value representing the added item’s zero-based index within the collection. + + + + Creates a new repository item of the specified type and adds it to the end of the collection. + + A string value specifying the repository item type by the corresponding editor type name. + A descendant representing the new repository item. + + + + Adds an array of repository items to the collection. + + An array of descendants to be added to the collection. + + + + Indicates whether the collection contains the specified repository item. + + A descendant to locate in the collection. + true if the collection contains the specified repository item; otherwise, false. + + + + Returns the specified repository item’s position within the collection. + + A descendant to locate in the collection. + An integer value representing the item’s zero-based index. -1 if the collection doesn’t contain the specified repository item. + + + + Provides indexed access to repository items. + + An integer value representing the item’s zero-based index within the collection. + A descendant representing the repository item located at the specified position. + + + + Gets the repository item specified by its name. + + A value specifying the name of the desired repository item. + A descendant representing the repository item with the specified name. null (Nothing in Visual Basic) if the collection doesn’t contain the specified item. + + + + Removes the specified repository item from the collection. + + A descendant representing the repository item to remove. + + + + Contains settings specific to a editor. + + + + + Initializes a new class instance with default settings. + + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Specifies the alignment of the preview color box within the control’s edit region. + + A value specifying the alignment of the preview color box within the control’s edit region. + + + + Occurs after the value of the ColorEdit.Color property has been changed. + + + + + Gets or sets whether a simple or advanced dialog is used to pick a custom color. + + A DevExpress.XtraEditors.Popup.ColorDialogType enumeration value, such as Simple or Advanced, that specifies whether a simple or advanced dialog is used to pick a custom color. The Default is Advanced. + + + + Gets or sets the value indicating the type of display text describing the selected color. + + The type of display text to represent the selected color. + + + + Gets or sets an array of user-defined colors to display in the Custom panel of the dropdown window. + + An array of user-defined colors to display in the Custom panel. + + + + Gets the default alignment of the editor contents when the editor is inplace within a container control. + + The HorzAlignment.Near value. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A string identifying the editor’s class name. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Specifies how selected items are highlighted within the control’s popup window. + + A value that specifies how selected items are highlighted. + + + + Gets or sets a null color. + + The null color. + + + + This property is not supported by the class. + + The Size.Empty value. + + + + This property is not supported by the class. + + The Size.Empty value. + + + + Gets an object containing settings specific to the control. + + The object containing settings for the current control. + + + + Gets or sets whether the Automatic button is displayed in the Custom tab. + + true if the Automatic button is displayed; otherwise, false. + + + + Gets or sets whether an end-user can select a custom color with a color pick dialog (the “Select Color” dialog). + + true if a color pick dialog is enabled; otherwise, false. + + + + Gets or sets the visibility of the Custom tab. + + true if the Custom tab is visible; otherwise, false. + + + + Gets or sets whether the More Colors button is displayed in the Custom tab. + + true if the More Colors button is displayed; otherwise, false. + + + + Gets or sets the visibility of the System tab that displays colors from the System.Drawing.SystemColors enumeration. + + true if the System tab is visible; otherwise, false. + + + + Gets or sets the visibility of the Web tab that displays colors provided by the System.Drawing.Color type. + + true if the Web tab is visible; otherwise, false. + + + + Gets or sets a value specifying the type of value returned by the ColorEdit.EditValue property. + + true if ColorEdit.EditValue stores the selected color as an integer; false if ColorEdit.EditValue stores it as a System.Drawing.Color structure. + + + + Gets or sets the style in which text is displayed in the control’s edit box. + + The value determining the editing style. + + + + Represents a repository item that stores settings specific to a control. + + + + + Initializes a new instance of the class. + + + + + Provides access to the appearance settings used to paint the hot-tracked cell border color. + + An object that specifies the appearance settings used to paint the hot-tracked cell border color. + + + + Provides access to the appearance settings used to paint the selected cell border color. + + An object that specifies the appearance settings used to paint the selected cell border color. + + + + Copies settings from the object passed as the parameter. + + A object whose settings are copied to the current object. + + + + Gets or sets the border color of the box displaying the “Automatic” color. + + The border color of the box displaying the “Automatic” color. + + + + Gets or sets the color considered the “Automatic” color, which is selected when an end-user clicks the Automatic button in the Custom tab. + + The color considered the “Automatic” color. + + + + Gets or sets the caption of the Automatic button displayed in the Custom tab in the control. + + A string that is the caption of the Automatic button displayed in the Custom tab. + + + + Contains settings that affect the appearance of the “Select Color” dialog. + + A object that contains settings affecting the appearance of the “Select Color” dialog. + + + + Fires after the “Select Color” dialog has been closed. + + + + + Fires when the “Select Color” dialog is about to be displayed. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the editor which owns the current repository item object. + + A editor owning the current repository item. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires the RepositoryItemColorPickEdit.TooltipShowing event. + + A object that contains data for the event. + + + + Provides access to colors displayed in the Recent Colors group in the Custom tab. + + A DevExpress.XtraEditors.ColorPickEditControl.Matrix object that comprises colors displayed in the Recent Colors group in the Custom tab. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the visibility of the Web-Safe tab. + + true if the Web-Safe tab is accessible to end-users; otherwise, false. + + + + Provides access to colors displayed in the Standard Colors group in the Custom tab. + + A DevExpress.XtraEditors.ColorPickEditControl.Matrix object that comprises colors displayed in the Standard Colors group in the Custom tab. + + + + Provides access to colors displayed in the Theme Colors group in the Custom tab. + + A DevExpress.XtraEditors.ColorPickEditControl.Matrix object that comprises colors displayed in the Theme Colors group in the Custom tab. + + + + Gets or sets how color values are formatted in tooltips. + + The display format of color values in tooltips. + + + + Allows you to customize tooltips displayed when the mouse cursor hovers over colors in the Custom and Web-Safe palettes. + + + + + Represents a repository item which stores settings specific to controls. + + + + + Initializes a new class instance with default settings. + + + + + Provides access to the appearance settings used to paint list items in the disabled state. + + A object that specifies the appearance settings used to paint list items in the disabled state. + + + + Provides access to the appearance settings used to paint hot tracked list items if items are not automatically selected when hot tracked. + + An object specifying the appearance settings used to paint hot tracked list items if items are not automatically selected when hot tracked. + + + + Provides access to the appearance settings used to paint list items in the selected state. + + An object that specifies the appearance settings used to paint list items in the selected state. + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Gets or sets a value that specifies whether the auto completion feature is enabled. + + true if the auto completion is enabled; otherwise, false. + + + + Performs specific actions before control initialization. + + + + + Gets or sets a value indicating whether the auto completion feature is case sensitive. + + true if the auto completion feature is case sensitive, otherwise false. + + + + Provides access to the settings applied to the context buttons displayed by the editor items. + + A DevExpress.Utils.SimpleContextItemCollectionOptions object that comprises settings applied to the context buttons displayed by the editor items. + + + + Provides access to the collection of context buttons displayed by editor items. + + A ContextItemCollection object that represents the collection of context buttons. + + + + Enables custom display text to be provided for editor items. + + + + + Allows you to assign custom HTML-CSS templates to combo box items. + + + + + Allows you to customize templated items dynamically. + + + + + Gets a value indicating whether the end-user can navigate through dropdown values by double clicking the edit box. + + true if double-clicking the edit box cycles through combo box items; otherwise, false. + + + + Provides the ability to custom paint the items displayed within the combo box editor’s drop down. + + + + + Occurs when drawing an item in the dropdown list. + + + + + Gets or sets the height of an item in the dropdown list. + + The height of an item in the dropdown window, in pixels. + + + + Gets or sets the number of items simultaneously displayed in the dropdown window. + + The number of visible items in the dropdown window. + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Notifies the editor that the initialization has been completed. + + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Specifies how selected and hot-tracked items are highlighted within the control’s popup window. + + A value that specifies how selected and hot-tracked items are highlighted. + + + + Gets or sets, if the items from the dropdown menu can be hot tracked. + + true if the Hot Track feature is enabled; otherwise, false. + + + + Gets or sets whether the items in the dropdown are hot-tracked when the mouse pointer moves over them. + + true if the items in the dropdown are hot-tracked; otherwise, false. + + + + Occurs when a user clicks an element within an HTML-CSS template. + + + + + Occurs when a mouse pointer is over an element of an HTML-CSS template, and a mouse button is pressed. + + + + + Occurs when a mouse button pressed over an element of an HTML-CSS template is released. + + + + + Stores HTML and CSS-based templates used to render combo box items. + + A collection of HTML and CSS-based templates used to render combo box items. + + + + Gets or sets whether the height of items is automatically calculated to fit their entire content. + + true if item height is automatically calculated; otherwise, false. + + + + Gets or sets padding within list items. + + A structure representing list item internal spacing characteristics. + + + + Provides access to the collection of items displayed in the editor’s dropdown. + + The collection of items displayed by the editor. + + + + Allows you to change the height of specific items in the dropdown window. + + + + + Gets the editor which owns the current repository item object. + + A control owning the current repository item. + + + + Gets an object providing properties specific to the combo box editor. + + The object providing settings specific to the combo box editor. + + + + Occurs on changing the index of the selected value in the combo box editor. + + + + + Occurs after changing the index of the selected value in the combo box editor. + + + + + Gets or sets whether tooltips are displayed for items whose text is trimmed. + + A value that specifies whether tooltips are displayed for items whose text is trimmed. + + + + Gets or sets whether the items are sorted. + + true to sort items; otherwise, false. + + + + Gets or sets a value indicating whether the Ctrl key must be pressed when scrolling combo box items. + + true if scrolling items requires the Ctrl key to be pressed; otherwise, false. + + + + A repository item storing settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets whether animation effects are applied when switching between calendar views. + + true if calendar views are switched using animation effects; otherwise, false. + + + + Gets or sets whether it is possible to select the extra days that are displayed in the current month calendar, but belong to the previous or next month. + + true if t is possible to select the extra days that belong to the previous or next month; otherwise, false. + + + + Contains appearance settings used to paint the calendar’s elements and date cells in various states. + + The calendar appearance settings. + + + + Provides access to the appearance settings used to paint disabled dates in the editor’s drop-down. + + An AppearanceObject that specifies appearance settings used to paint disabled dates in the editor’s drop-down. + + + + Gets the appearance settings used to paint the header panel in the dropdown calendar. + + A object which provides the appearance settings used to paint the header panel in the dropdown calendar. + + + + Gets the appearance settings used to paint the highlighted header panel in the dropdown calendar. + + A object, that contains the appearance settings used to paint the header panel’s text under the mouse pointer. + + + + Gets the appearance settings used to paint the text within the dropdown calendar. + + A object that contains the appearance settings used to paint the text under the mouse pointer, within the editor’s dropdown. + + + + Provides appearance settings used to paint week numbers. + + An object that contains the corresponding appearance settings. + + + + Copies source repository item properties to the current object. + + The source repository item object. + + + + Gets or sets whether an end-user can select a date in the dropdown calendar. Disable this setting to allow end-users to enter only the time portions of date-time values (see RepositoryItemDateEdit.CalendarTimeEditing). + + true if an end-user can select a date in the calendar; otherwise, false. + + + + Gets or sets that defines the culturally appropriate format for displaying dates and times. + + A object that defines the culturally appropriate format for displaying dates and times. + + + + Gets or sets whether an end-user can edit the time portion of a date value in the dropdown calendar. + + A value that specifies whether an end-user can edit the time portion of a date value in the dropdown calendar. + + + + Contains settings related to time editing within the DateEdit control’s dropdown calendar. + + An object that contains settings related to time editing within the DateEdit control’s dropdown calendar. + + + + Gets or sets the appearance of the calendar in the drop-down window. + + A enumearation value that specifies the calendar appearance. + + + + Gets or sets size of calendar cells in the control’s drop-down. + + The calendar cell size, in pixels. + + + + Gets or sets the ICalendarCellStyleProvider object that allows you to customize the appearance of certain dates. + + The object that allows you to customize the appearance of certain dates. + + + + Gets or sets the number of months displayed horizontally in the dropdown calendar. + + The number of months displayed horizontally. + + + + Occurs when drawing day cells in the dropdown calendar. + + + + + Allows you to provide custom week day abbreviations. + + + + + Allows week numbers to be customized. + + + + + Specifies how a responds to an attempt to enter an invalid date value. + + A value specifying how to respond to an invalid date value. + + + + Occurs after the value of the DateEdit.DateTime property has been changed. + + + + + Allows specific dates or date ranges to be disabled in the editor’s drop-down to prevent them from being selected by an end-user. + + + + + Allows you to assign an ICalendarDisabledDateProvider object that can disable certain dates to prevent them from being selected by an end-user. + + An object that can disable certain dates to prevent them from being selected by an end-user. + + + + Gets the format settings applied to the editor when it is not focused. + + A object containing format settings. + + + + Gets or sets whether to draw lines between calendar cells. + + true if lines between calendar cells are visible; otherwise, false. + + + + Provides the ability to custom paint day cells in the dropdown calendar. + + + + + Provides access to the settings used to format the edit value when the editor has input focus. + + A object containing format settings. + + + + Gets or sets an edit mask. + + A string specifying a mask expression. + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Gets or sets the first day of the week. + + A enumeration value specifying the first day of the week. + + + + Gets or sets whether Saturdays and Sundays are highlighted. + + true to highlight Saturdays and Sundays; otherwise, false. + + + + Gets or sets whether today’s date is highlighted in the editor’s drop-down. + + A DefaultBoolean enumeration value that specifies whether today’s date is highlighted in the editor’s drop-down. + + + + Gets or sets whether today’s date is highlighted in the editor’s drop-down when selected, or belongs to a selected range of dates. + + true if today’s date is highlighted in the editor’s drop-down when selected, or belongs to a selected range of dates; otherwise, false. + + + + Gets or sets the editor’s maximum value. + + A structure which represents the maximum allowed date. + + + + Gets or sets the editor’s minimum value. + + A structure which represents the minimum allowed date. + + + + Gets or sets a value that is interpreted as the null date. + + A value interpreted as the null date. + + + + Gets or sets the date and time automatically selected in the editor’s drop-down if the edit value is set to null. + + A DateTime object that specifies the date and time automatically selected in the editor’s drop-down if the edit value is set to null (Nothing in VB.NET). + + + + This property is not supported by the class. + + The Size.Empty value. + + + + This property is not supported by the class. + + The Size.Empty value. + + + + Gets an object providing properties specific to the button edit control. + + The object. + + + + Gets or sets the number of months displayed vertically in the dropdown calendar. + + The number of months displayed vertically. + + + + Gets or sets whether a single date, or multiple dates can be simultaneously selected. + + A enumeration value that specifies whether a single date, or multiple dates can be simultaneously selected. + + + + Gets or sets whether the dropdown calendar contains the Clear button (this button is not supported in CalendarView.TouchUI mode). + + true if the dropdown calendar contains the Clear button; otherwise, false. + + + + Gets or sets the visibility of month names for each month. + + true if the month name is displayed above each month; otherwise, false. + + + + Gets or sets the visibility of buttons that let an end-user navigate between months. + + A enumeration value that specifies the visibility of buttons that let an end-user navigate between months. + + + + Gets or sets whether the OK button is displayed. + + A enumeration value that specifies whether the OK button is displayed. + + + + Gets or sets whether to display the Today button in the dropdown calendar (in Classic and Vista modes). + + true if the Today button is visible; otherwise,false. + + + + Gets or sets whether to display week numbers in the dropdown window. + + true if the dropdown window displays week numbers; otherwise, false. + + + + Gets or sets the visibility of buttons that let an end-user navigate between years. + + A enumeration value that specifies the visibility of buttons that let an end-user navigate between years. + + + + Allows you to mark certain dates as “special” dates. These dates will be painted using the dedicated settings provided by the RepositoryItemDateEdit.AppearanceCalendar object. + + + + + Allows you to assign an ICalendarSpecialDateProvider object that can mark certain dates as “special” to highlight them in a custom manner, as specified by the dedicated appearance settings of the RepositoryItemDateEdit.AppearanceCalendar object. + + An object that marks certain dates as “special”. + + + + Gets or sets the width, in pixels, of the edit box in the control’s drop-down that allows end-users to edit the time portion of the edit value. + + An integer value that specifies the width, in pixels, of the time portion edit box. + + + + Fires when the Today button is clicked. + + + + + Gets or sets the date that is regarded as Today’s date. + + The date that is regarded as Today’s date. + + + + Gets or sets the step by which minutes increment in the touch-aware calendar. The value of 60 must be multiple of TouchUIMinuteIncrement. + + The number by which minutes increment in the touch-aware calendar. + + + + Gets or sets the step by which seconds increment in the touch-aware calendar. The value of 60 must be multiple of TouchUISecondIncrement. + + The number by which seconds increment in the touch-aware calendar. + + + + Gets or sets the initial date grouping View that is enabled when a date editor opens. + + A VistaCalendarInitialViewStyle enumeration value that specifies the initial date grouping View that is enabled when a date editor opens. + + + + Gets or sets which date grouping Views are available in Vista display mode. + + A value that specifies which date grouping Views are available in Vista display mode. + + + + Gets or sets whether the editor’s dropdown calendar looks and functions like the Date Editor in Windows Vista. + + A value that specifies whether the editor’s dropdown calendar looks and functions like the Date Editor in Windows Vista. + + + + Gets or sets whether the DateEdit control’s dropdown calendar contains a time editor for editing the time portion of the date-time value. + + A value that specifies whether the dropdown calendar contains a time editor. + + + + Contains settings that control the appearance and behavior of the time editor embedded into the DateEdit control’s dropdown calendar. + + A object that contains appearance and behavior settings of the time editor embedded into the DateEdit control’s dropdown calendar. + + + + Gets or sets the length of days of the week abbreviations. + + The length of days of the week abbreviations. + + + + Gets or sets a rule which determines the first week of the year. + + A enumeration value which determines the first week of the year. + + + + A repository item that stores core settings of the editor. + + + + + Initializes a new instance of the class. + + + + + If you add custom buttons to the Buttons collection, this property allows you to assign one of these buttons to open and close the editor drop-down menu. See the RepositoryItemPopupBase.ActionButtonIndex property for more details. + + An index of a button inside the Buttons collection. + + + + Gets or sets whether an editor can show its drop-down menu when read-only. + + Specifies whether read-only editors can show their drop-down menus. + + + + Occurs when the editor drop-down menu is closed. Allows you to identify what caused the menu to close. Equivalent to the DateTimeOffsetEdit.Closed event (see the link for more details). + + + + + Fires when the editor drop-down menu is closing and allows you to decide whether changes made by a user should be accepted. See the PopupBaseEdit.CloseUp event for an example. + + + + + Allows you to assign a hotkey that closes the editor drop-down menu. + + A hotkey that closes the editor drop-down menu. + + + + Gets or sets the active mask expression. This property is synchronized with the “MaskExpression” setting available through the RepositoryItemTextEdit.MaskSettings group. + + The active mask expression. + + + + Returns “DateTimeOffsetEdit”. + + The editor class name. + + + + Returns the display text of the target value, formatted according to the given settings. + + Specifies format settings. + A value to be formatted. + The formatted display text. + + + + Occurs after the editor shows its drop-down menu. Do not invoke any message boxes within this event handler. + + + + + This member is not supported. + + Specifies the editor menu border style. + + + + This property is not available for DateTimeOffsetEdit editors. + + + + + + This property is not available for DateTimeOffsetEdit editors. + + + + + + This property is not available for DateTimeOffsetEdit editors. + + + + + + This property is obsolete (please remove the ‘Properties.’ string from the call). + + + + + + Fires when the editor drop-down menu is about to close. Allows you to set the Cancel property to true to keep this menu open. Does not occur when a user clicks outside the editor or switches to another application. See the RepositoryItemPopupBase.QueryCloseUp event for more details. + + + + + Fires when the editor is about to open its drop-down menu. Allows you to set the Cancel property to true to keep this menu closed. See the RepositoryItemPopupBase.QueryPopUp event for more information. + + + + + Gets or sets whether a user can click an editor text box to open the drop-down menu, and whether a single or a double click is required. A single click opens the editor drop-down only when the RepositoryItemButtonEdit.TextEditStyle property equals TextEditStyles.DisableTextEditor. + + Specifies whether users can click or double-click the editor to open its drop-down menu. + + + + Gets or sets whether the editor drop-down menu should display a drop shadow. + + true, to display a menu shadow; false, to hide it. + + + + This property is not supported for DateTimeOffsetEdit editors. + + + + + + This property is not supported for DateTimeOffsetEdit editors. + + + + + + If an editor drop-down menu is open and a user clicks another UI element on a form, this menu closes and the clicked element fires its Click event. If this property is enabled, the menu closes but the element’s Click event does not occur. This allows you to ensure that users do not accidentally click unwanted elements when they click outside an open drop-down menu to close it. + + Specifies whether the editor should suppress mouse events when the menu is open. + + + + For internal use. + + + + + Represents the class which stores settings specific to the control. + + + + + Initializes a new instance of the class. + + + + + Copies properties and event handlers of the source repository item to the current object. + + The source repository item object. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This property is not supported by the class. + + A value. + + + + This property is not supported by the class. + + A value. + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + This property is not relevant for this class. + + + + + Gets the collection of items displayed in the dropdown. + + A object. + + + + This property is not supported by the class. + + A object. + + + + For internal use. + + + + + Gets or sets the maximum number of items in the editor’s MRU list. + + An integer value that specifies the maximum number of items in the editor’s MRU list. + + + + Gets or sets whether a FontEdit editor only displays the fonts that support the Regular font style. + + A Boolean value that specifies whether a FontEdit editor only displays the fonts that support the Regular font style. + + + + Gets or sets whether sample previews are displayed for symbol fonts in the dropdown. + + true if sample previews are displayed for symbol fonts in the dropdown; otherwise, false. + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + A value. + + + + For internal use. + + + + + Represents the class which provides settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Copies properties of the specified repository item. + + A object representing the source repository item. + + + + Gets or sets the manner in which the window for the process executed by the hyperlink editor should appear on-screen. + + A value, specifying the manner in which the window for the process executed by the hyperlink editor should appear. + + + + Gets or sets the caption string displayed in the edit box. + + A string value specifying the hyperlink editor’s caption. + + + + The method overrides the base RepositoryItemButtonEdit.CreateDefaultButton method to prevent it from creating a default button. + + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Returns the foreground color of the link’s text. + + A Color used to paint the link’s text. + + + + Gets or sets the alignment of the image displayed within the edit box. + + A enumeration member which specifies the image’s alignment. + + + + Gets or sets the image displayed within the edit box. + + A object which represents the image displayed within the edit box. + + + + Gets or sets the alignment of the image displayed within the edit box. + + A enumeration member which specifies the image’s alignment. + + + + Gets or sets the foreground color of the editor’s display text. + + The color of the editor’s display text. + + + + Gets or sets whether the link text color is specified by parent appearance settings. + + true if the link text color is specified by parent appearance settings; otherwise, false. + + + + Occurs before hyperlink execution. + + + + + Gets or sets the image displayed within the edit box. + + A object which represents the image displayed within the edit box. + + + + Gets an object providing settings specific to the current control. + + The object providing settings common to the current edit control. + + + + Gets or sets the read-only status of the editor. + + true if the end-user cannot modify the editor’s contents; otherwise false. + + + + Gets or sets whether hyperlink functionality is activated a single or double click. + + true if the hyperlink functionality is activated by single clicking; otherwise, the user needs to double click the edit box in order to execute the hyperlink command. + + + + Gets or sets a shortcut to activate the hyperlink. + + The shortcut used to activate the hyperlink functionality. + + + + Gets or sets whether a click/double-click on the empty space in the edit box invokes the hyperlink’s functionality. + + true if a click/double-click on the empty space invokes the hyperlink’s functionality; otherwise, false. + + + + Gets or sets the style in which text is displayed and edited in the editor. + + The value determining the editing style. + + + + When embedded in a container’s column/cell, allows cell text to be formatted using HTML tags. No editing is supported for these cells. + + + + + Initializes a new instance of the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Assigns property values of the specified object to the corresponding properties of this object. + + A object whose property values are copied to the current object. + + + + This property is not supported by the class. + + + + + Gets or sets the window state to use when a browser is opened. + + One of the enumeration values that indicates whether the process is started in a window that is maximized, minimized, normal (neither maximized nor minimized), or not visible. + + + + This method is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Gets whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. + + Always ExportMode.DisplayText. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + For internal use. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Fires when a hyperlink is clicked, and a browser is about to be opened. + + + + + This property is not supported by the class. + + + + + Provides access to properties specific to the control. + + The object comprising properties specific to the control. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + Always true. + + + + For internal use. + + + + + This property is not supported by the class. + + + + + For internal use. + + + + + If the label contains a hyperlink, gets or sets whether a single or double click opens a browser. + + true, to use a single click to open a browser; otherwise, false. + + + + Gets the style in which text is displayed the editor. + + Always TextEditStyles.DisableTextEditor. + + + + For internal use. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Represents a repository item which holds settings specific to controls. + + + + + Initializes a new class instance with default settings. + + + + + Populates this with items generated from values of the specific enumeration. Allows generated items to store numeric enumeration values instead of enumeration constant names. + + A type of enumeration whose values should be used to generate items. + true if values for generated items should store numeric enumerator values ; false if these values should store constant enumerator names instead. + + + + Populates this with items generated from values of the specific enumeration. + + A type of enumeration whose values should be used to generate items. + + + + Populates this with items generated from values of the specific enumeration. + + + + + Adds new items that represent elements of the specified enumeration to the control. Allows you to customize item descriptions and specify whether underlying integer values are assigned to the item values. + + A System.Converter delegate that generates item descriptions to be displayed. + true, if values for generated items should store numeric enumerator values; false, if these values should store constant enumerator names instead. + The type of the required enumeration. + + + + Populates this with items generated from values of the specific enumeration and replaces default item descriptions. + + A Delegate that encapsulates a method which replaces generated items’ captions. + + + + Adds image items to the . + + The image list to add to the . + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Gets or sets the casing mode according to which a will display the selected value. + + A enumerator value that specifies the casing mode. + + + + Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. + + A DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter descendant used to paint the group rows in the XtraGrid. + + + + Gets the alignment of the editor contents when the editor works as an inplace control. + + The HorzAlignment.Near value. + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Gets or sets the alignment of item images. + + The value that specifies the alignment of item images. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the collection of items displayed in the dropdown window. + + The collection of items for the image combo box editor. + + + + Gets or sets the source of large images. + + An object that is an image collection providing large images for the editor’s items. + + + + Gets an object providing properties specific to the image combo box editor. + + The object providing settings specific to the image combo box editor. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + true always. + + + + Gets or sets the source of small images. + + An object that is an image collection providing small images for the editor’s items. + + + + Gets or sets the style in which text is displayed in the control’s edit box. + + The value determining the editing style. + + + + Represents a repository item which stores settings specific to an control. + + + + + Initializes a new class instance with default settings. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Copies settings of the specified repository item to the current one. + + A object representing the source of the operation. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Occurs after the value of the ImageEdit.Image property has been changed. + + + + + Gets or sets the alignment of the image within the image editor. + + A enumeration value which specifies the image’s alignment. + + + + Gets or sets how the editor stores the image pasted via the editor’s context menu. + + A value representing how an image loaded via the editor’s context menu is stored in the edit value. + + + + Gets an object providing properties specific to an image edit control. + + A object instance. + + + + Gets or sets a value indicating whether the context menu is displayed when the dropdown window is right-clicked. + + true if the context menu is displayed when the dropdown window is right-clicked. + + + + Gets or sets a value specifying how the image is displayed within the image editor. + + A enumeration value. + + + + Gets or sets the colorization mode for the object’s SVG image. + + Colorization mode. + + + + Contains settings specific to a lookup editor. + + + + + Creates and initializes a new instance of the class. + + + + + Gets or sets whether a custom value (a value that is not present in the lookup data source) that is entered in the edit box is accepted by the editor (when the value is validated and editor loses focus). This property supports ComboBox mode for the lookup editor. + + A value that specifies if custom values are accepted by the editor. The DefaultBoolean.Default property value is equivalent to True. + + + + Adds the checkbox selector column to the lookup. + + + + + Gets whether it is allowed to update popup width. + + true if it is allowed to update popup width; otherwise, false. + + + + Gets the header panel’s appearance settings. + + A object which provides the appearance settings used to paint the column headers. + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Fires when the editor SearchMode property is set to AutoSearch. In this mode, the editor filters out data source records that do not match the currently entered text, and displays remaining records in the drop-down panel. The AutoSearch event is optional, it allows you to fine-tune the search. See the class description to learn more. + + + + + Gets or sets the visible column index against which an incremental search is performed in SearchMode.AutoComplete and SearchMode.OnlyInPopup modes. + + The zero-based visible column index against which an incremental search is performed. + + + + Fires when a search in mode completes. + + + + + Fires when you set the SearchMode property to AutoSuggest. In this mode, the editor runs the asynchronous Task assigned in the event handler to retrieve a list of drop-down panel items. See the class description for more information. + + + + + Fires after the AutoSuggest event is finished. Allows you to additionally customize the editor. + + + + + Changes the widths of columns in the dropdown, to best fit their contents. + + The adjusted total width of the columns in the dropdown. + + + + Specifies the maximum number or rows that are processed when invoking the “best-fit” functionality. + + An integer value that specifies the maximum number of rows processed when invoking the “best-fit” functionality. + + + + Gets or sets whether the end-user needs to type text matching the case when performing an incremental search. + + true if an incremental search is case sensitive; otherwise false. + + + + Gets or sets the name of the data source field that specifies whether the item is selected. + + The name of the data source field that specifies whether the item is selected. + + + + Provides access to the collection of columns displayed in the dropdown window. + + A object specifying the columns displayed in the dropdown. + + + + Provides the capability to perform custom painting of grid cells in the drop-down. + + + + + Provides the capability to perform custom painting of grid column headers in the drop-down. + + + + + Provides the capability to perform custom painting of vertical grid lines in the drop-down. + + + + + Provides the capability to perform custom painting of grid rows in the drop-down. + + + + + Occurs after the property has been changed. + + + + + Gets or sets the height of a row in the dropdown (in pixels). + + The height of a single row. + + + + Gets or sets the height of the dropdown (in rows). + + The number of visible rows in the dropdown window. + + + + Gets the class name of an edit control corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Gets or sets whether the editor’s property returns a selected item, a list of selected items, or a string that combines property values of selected items. + + The property type. + + + + Gets or sets whether you can bind the LookUpEdit.EditValue property to a read-only property of a collection type. With this option enabled, the editor calls the collection’s methods to add and remove items. + + True to use the collection’s methods to add and remove items.False to create a new collection each time the EditValue property is changed.Default is True if the EditValue property is bound to a read-only property of a collection type. + + + + Finishes the initialization of the LookUp editor’s data source. Call this method when the form is loading, before you start to create columns or obtain column values. + + + + + Returns a data source row containing the specified RepositoryItemLookUpEditBase.DisplayMember field value. + + The value of the RepositoryItemLookUpEditBase.DisplayMember field for the row to be located. + An object representing the data source record containing the specified value. null (Nothing in Visual Basic) if no record with the specified value in the RepositoryItemLookUpEditBase.DisplayMember field was found. + + + + Returns a data source row containing the specified RepositoryItemLookUpEditBase.ValueMember field value. + + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row to be located. + An object representing the data source record containing the specified value. null (Nothing in Visual Basic) if no record with the specified value in the RepositoryItemLookUpEditBase.ValueMember field was found. + + + + Searches for an object that represents the row containing the specified field values. + + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row to be located. + An array of objects representing values for additional fields against whose values the search is performed. + An array of strings specifying the names of the fields against whose values the search will be carried out. + An object representing the data source record containing the specified value. null (Nothing in Visual Basic) if no record is found that matches the given search criteria. + + + + Returns the visible index of the row in a data source that contains the specified value in the specified column. + + A object that is the column whose values will be compared with the specified value to locate the required row. + A value contained in the required row in the specified column. + An integer value that is the row’s zero-based visible index in the data source. -1 if the row was not found. + + + + Returns the visual index of the row in the dropdown that contains the specified value in the specified field. + + A string that is the field whose values will be compared with the specified value to locate the required row. + A value contained in the required row in the specified field. + An integer value that is the row’s zero-based visual index in the dropdown. -1 if such a row is not found. + + + + Gets the value contained in the specified row and column in the dropdown data source. + + A object representing the column that contains the required value. + An integer value specifying the row’s visual index in the dropdown list. + An object representing the value contained in the specified row and column. null if the specified row or column is not found. + + + + Gets the value contained in the specified row and field in the dropdown data source. + + A string representing the field name that contains the required value. + An integer value specifying the row’s visual index in the dropdown list. + An object representing the value in the specified row and column. null if the specified row or field is not found. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Returns a value of the RepositoryItemLookUpEditBase.DisplayMember field of the row containing the specified RepositoryItemLookUpEditBase.ValueMember field value. + + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row to locate. + The value of the RepositoryItemLookUpEditBase.DisplayMember field for the row located.null if no record with the specified value was found (System.DBNull.Value and the data source is a object). + + + + Gets a value of the RepositoryItemLookUpEditBase.DisplayMember field by multiple key values. + + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row to be located. + An array of objects representing values for additional fields against whose values the search is performed. + An array of strings specifying names of additional fields against whose values the search is carried out. + The value of the RepositoryItemLookUpEditBase.DisplayMember field for the row located. null if no record with the specified value was found. + + + + Returns the value of the RepositoryItemLookUpEditBase.ValueMember field for the row whose RepositoryItemLookUpEditBase.DisplayMember value matches the specified text. + + A text representation of the RepositoryItemLookUpEditBase.DisplayMember field in the row to locate. + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row located,null if no record with the specified value was found (System.DBNull.Value when the data source is a object). + + + + Returns a value of the RepositoryItemLookUpEditBase.ValueMember field of the row containing the specified RepositoryItemLookUpEditBase.DisplayMember field value. + + The value of the RepositoryItemLookUpEditBase.DisplayMember field for the row to locate. + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row located.null if no record with the specified value was found (System.DBNull.Value when the data source is a object). + + + + Gets the index of a specific row in the underlying data source. + + A row’s visual position in the dropdown window. This index can be obtained via the RepositoryItemLookUpEdit.GetDataSourceRowIndex method. + The index of a specific row in the underlying data source. + + + + Occurs on retrieving values for fields not found in the RepositoryItemLookUpEditBase.DataSource. + + + + + Gets or sets which functionality is invoked as a result of clicking a column header within the dropdown. + + A value specifying how the editor acts after its column header is clicked. + + + + Specifies how selected and hot-tracked items are highlighted within the control’s popup window. + + A value that specifies how selected and hot-tracked items are highlighted. + + + + Gets or sets a value specifying whether the items in the popup window are hottracked when the mouse pointer passes over them. + + true if the items in the popup window are hottracked when the mouse pointer passes over them; otherwise, false. + + + + Gets or sets a value specifying whether the rows in the popup window are hot-tracked when the mouse pointer passes over them. + + true if the rows in the popup window are hot-tracked when the mouse pointer passes over them; otherwise, false. + + + + Occurs after a record(s) in the RepositoryItemLookUpEditBase.DataSource has been changed. + + + + + Gets or sets the maximum number of characters displayed in the edit box. + + The maximum number of characters displayed in the edit box. The minimum value is 10. + + + + Returns the width of the widest column value in pixels (taking the column’s caption into account). This overloaded method uses GraphicsCache for the sake of performance. + + The graphics cache. + The column being processed. + The column width. + + + + Returns the width of the widest column value in pixels (taking the column’s caption into account). + + The graphics surface. + The column being processed. + The a column width. + + + + Gets the editor which owns the current repository item object. + + A control owning the current repository item. + + + + Creates columns for all fields available in the lookup data source (RepositoryItemLookUpEditBase.DataSource). + + + + + Allows you to provide a custom filter criteria. + + + + + Gets or sets how data records in the popup window are filtered. + + A enumerator value that specifies how data records in the popup window are filtered. + + + + This property is not supported by the class. + + The Size.Empty value. + + + + Gets or sets the width of the dropdown window (in pixels). + + The width of the dropdown window. + + + + Allows you to select items based on values in the data source field specified by the property. + + + + + Removes the checkbox selector column from the lookup. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + true always. + + + + Gets or sets whether to immediately apply the found value to the editor as a user types a query, or only highlight the found value in the drop-down window. + + A enumeration value that specifies the search mode. + + + + Gets or sets whether the LookUp selects the first found item in the drop-down list when the user presses Enter. + + True to select the first found item in the drop-down list when the user presses Enter; otherwise, Default or False. + + + + Occurs after a user selects an item in the editor’s popup. This event works in Multiple Item Selection mode only. + + + + + Occurs before a user selects an item in the editor’s popup. This event works in Multiple Item Selection mode only. + + + + + Gets or sets the character that separates selected items in the edit box. + + A separator character. + + + + Allows you to post values that correspond to the selected item state to the data source field specified by the property. + + + + + Gets or sets the visibility of column headers. + + true if column headers are visible; otherwise, false. + + + + Gets or sets the visibility of vertical lines separating columns in the dropdown. + + true if vertical lines separating columns are visible; otherwise, false. + + + + Gets or sets whether to display OK and Cancel buttons in the popup. + + true to display OK and Cancel buttons in the popup; otherwise, false. + + + + Gets or sets the column index against which data is sorted. + + The zero-based column index against which data is sorted. + + + + Gets or sets a value that specifies whether users can type in the lookup’s text box. + + A TextEditStyles enumeration value. + + + + Gets or sets whether the number of visible data rows limits the height of the dropdown window. + + true if the height of the dropdown cannot be greater than the number of data rows; otherwise, false. + + + + Represents the base class that contains settings common to lookup editors. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets whether it is allowed to update popup width. + + true if it is allowed to update popup width; otherwise, false. + + + + Copies settings of the specified repository item. + + A object representing the source of the operation. + + + + Gets or sets the “best-fit” mode for columns in the dropdown window. + + A value that specifies the “best-fit” mode for columns in the dropdown window. + + + + Gets or sets the name(s) of the foreign key field(s) by which the popup data source of the current lookup editor is filtered. + + The foreign key field name(s). + + + + Gets or sets the source of data displayed in the dropdown window. + + The source of data displayed in the dropdown. + + + + Gets the default alignment of the editor’s contents when the editor operates as an inplace control. + + The HorzAlignment.Near value. + + + + Gets or sets the field whose values are displayed in the edit box. + + The string identifying the field whose values are displayed in the edit box. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets a string that specifies a key field (or multiple key fields) used for business object identification (when a lookup editor is bound to a business object). + + A string that specifies a key field or multiple key fields delimited by the ‘;’ character. + + + + Gets the editor which owns the current repository item object. + + A descendant that owns the repository item. + + + + Gets or sets a value indicating whether the dropdown window is sizeable. + + true if the dropdown is sizeable; otherwise, false. + + + + Gets or sets whether the initial popup width matches the editor or content width. + + A DevExpress.XtraEditors.PopupWidthMode enumeration value, such as ContentWidth or UseEditorWidth, that specifies whether the initial popup width matches the editor or content width. + + + + Occurs when a new value entered into the edit box is validated. + + + + + This member supports the .NET Framework infrastructure and cannot be used directly from your code. + + + + + Gets or sets whether the dropdown window’s footer region is visible. + + true if the footer is visible; otherwise, false. + + + + Gets or sets the style in which text is displayed and edited in the editor. + + A value determining the editing style. + + + + Gets or sets whether the LookUp editor automatically detects data type issues and throws an exception. + + true to throw an exception when data type issues occur; otherwise, false. + + + + Gets or sets whether you should use the CTRL+UP-DOWN ARROW/CTRL+MOUSE WHEEL or UP-DOWN ARROW/MOUSE WHEEL combinations to scroll lookup records when the pop-up window is closed. + + true if you need to hold down the CTRL key when you use the UP or DOWN ARROW/MOUSE WHEEL combinations; false if the CTRL key should not be pressed. + + + + Gets or sets the field name whose values identify dropdown rows. + + The string representing the field name whose values identify dropdown rows. + + + + Contains settings specific to a editor. + + + + + Initializes a new instance of the class. + + + + + Provides access to the appearance settings. Note that some appearance settings (e.g., BackColor) are not in effect since the control is skinned. + + A DevExpress.XtraEditors.Repository.ProgressBarAppearanceObject object that stores appearance settings. + + + + Provides access to the appearance settings applied when the control is disabled. + + A DevExpress.XtraEditors.Repository.ProgressBarAppearanceObject object that stores appearance settings applied when the control is disabled. + + + + Provides access to the appearance settings applied when the control is focused. + + A DevExpress.XtraEditors.Repository.ProgressBarAppearanceObject object that stores appearance settings applied when the control is focused. + + + + Provides access to the appearance settings applied when the control is in a read-only state. + + A DevExpress.XtraEditors.Repository.ProgressBarAppearanceObject object that stores appearance settings applied when the control is in a read-only state. + + + + Copies settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Gets the editor’s class name. + + The string that represents the editor’s class name. + + + + Gets or sets the time period that it takes the progress block to move by one chunk across the progress bar. + + An integer value that specifies the time period, in milliseconds, that it takes the progress block to move by one chunk across the progress bar. + + + + Gets or sets the width, in pixels, of the progress block. + + An value that specifies the width, in pixels, of the progress block. + + + + Gets or sets whether the progress bar animation is paused. + + true if the progress bar animation is paused; otherwise, false. + + + + Gets or sets the animation mode of the control. + + A value that specifies the animation mode. + + + + Gets an object that provides properties specific to the marquee progress bar. + + A object that provides settings specific to the marquee progress bar. + + + + Gets or sets whether the control’s animation is stopped. + + true if the control’s animation is stopped; otherwise, false. + + + + Represents a class which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets a value specifying whether return characters can be inserted into text. + + true if return characters are accepted and processed by a memo editor; otherwise, false. + + + + Gets or sets a value specifying whether a user can insert tab characters into text. + + true if users can enter tabs in a memo editor using the TAB key; false if pressing the TAB key moves focus to another control. + + + + Copies the settings of a repository item. + + A object representing the source object. + + + + Gets a value indicating whether the autoheight feature is enabled. + + Always false . + + + + Gets the class name of the edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the number of lines to be displayed in a memo editor when it acts as an in-place control. + + An integer value specifying the number of lines displayed by an in-place memo editor. + + + + Provides access to the editor’s mask settings. + + A object which contains the editor’s mask settings. + + + + For internal use. + + + + + This property isn’t used. + + + + + Gets an object providing properties specific to a memo edit control. + + A object instance providing settings common to a memo edit control. + + + + Gets or sets whether the control displays the horizontal and/or vertical scroll bar. + + A enumeration value that specifies whether the control displays the horizontal scroll bar, the vertical scroll bar, both, or has no scroll bars. + + + + For internal use. + + + + + This property is not supported by the class. + + + + + Gets or sets whether the editor automatically wraps words to the beginning of the next line when necessary. + + true if the editor automatically wraps words to the beginning of the next line; otherwise, false. + + + + Represents a repository item which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets a value specifying whether a user can insert return characters into text. + + true if return characters typed within the dropdown window are accepted and processed by an extended memo editor; otherwise, false. + + + + Gets or sets a value specifying whether a user can insert tab characters into the editor’s text. + + true if tab characters typed within the dropdown window are accepted and processed by an extended memo editor; otherwise, false. + + + + Copies settings of the specified repository item to the current one. + + A object representing the source of the operation. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets an object providing properties specific to an extended memo edit control. + + A object instance. + + + + Gets or sets a value indicating which scrollbars are displayed within the editor’s dropdown window. + + A enumeration value indicating whether 0, 1 or 2 are displayed within the dropdown window. + + + + Gets or sets a value specifying whether the text is automatically wrapped at the right margin of the editor’s dropdown window. + + true if an editor always wraps text at the right margin. + + + + Represents a class which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Occurs before an item is added to the MRU editor. + + + + + Gets or sets whether close (‘x’) buttons are displayed within dropdown MRU items, allowing an end-user to delete items. + + true if close (‘x’) buttons are displayed within dropdown MRU items; otherwise, false. + + + + Copies the settings of a specific repository item to the current one. + + A object representing the source of the operation. + + + + Gets or sets a value that specifies whether the auto completion feature is enabled. + + true if the auto completion is enabled; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + Gets the class name of an edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Gets or sets a value that specifies whether the popup window is displayed immediately after an end-user has typed a character in the edit box. + + true if the popup window is displayed immediately after an end-user has typed a character in the edit box; otherwise, false. + + + + Gets the collection of items displayed by the current MRU editor. + + A MRUEditItemCollection object representing a collection of items displayed by the editor. + + + + Loads the RepositoryItemMRUEdit.Items collection with data from the specified stream. + + A Stream object that contains items to be loaded. + + + + Loads items from the specified XML file to the RepositoryItemMRUEdit.Items collection. + + A string that specifies the full path to the XML file that stores items to be loaded. + + + + Gets or sets the maximum number of items displayed in the editor’s dropdown list. + + An integer value specifying the maximum number of items contained by the MRU editor. + + + + Gets an object providing properties specific to a MRU edit control. + + A object instance providing settings common to a MRU edit control. + + + + Occurs before an item is removed from the MRU edit. + + + + + Saves items from the RepositoryItemMRUEdit.Items collection to a stream. + + A stream to which data is saved. + + + + Saves items stored in the RepositoryItemMRUEdit.Items collection to the specified XML file, using the specified encoding. + + A string that specifies the full path to the XML file to which data is saved. + An object that specifies the text encoding to use. + + + + Saves items stored in the RepositoryItemMRUEdit.Items collection to the specified XML file, using the default encoding. + + A string that specifies the full path to the XML file to which data is saved. + + + + Gets or sets a value specifying whether to invoke the RepositoryItem.Validating event when pressing the ENTER key. + + true if the RepositoryItem.Validating event is fired when the ENTER key is pressed; otherwise, false + + + + Represents a repository item which provides settings specific to an image combo box control. + + + + + Creates a repository item for an image combo box editor. + + + + + Represents a repository item which stores settings specific to a control. + + + + + Initializes a new class instance with default settings. + + + + + Gets or sets whether the pictures being edited are changed using animation. This property is not in effect for in-place editors. + + True if the pictures being edited are changed using animation; False if not; Default uses the WindowsFormsSettings.AnimationMode global setting. + + + + Gets or sets whether to dispose of the control’s image when the control is disposed of. + + true to dispose of the current image when the control is disposed of; otherwise, false. + + + + Gets or sets a value specifying whether a focus rectangle is displayed within the focused picture editor. + + true if a focus rectangle is displayed in the focused picture editor; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether it is allowed to scroll pictures using the mouse wheel. + + A enumeration value that specifies whether it is allowed to scroll pictures using the mouse wheel. + + + + Gets or sets whether an image can be scrolled by dragging it with the mouse. This feature is in effect when scroll bars are enabled via the RepositoryItemPictureEdit.ShowScrollBars property. + + true if an image can be scrolled by dragging it with the mouse; otherwise, false. + + + + Gets or sets whether it is allowed to zoom pictures using the mouse wheel. + + A enumeration value that specifies whether it is allowed to zoom pictures using the mouse wheel. + + + + Copies the settings of a specific repository item to the current one. + + A object representing the source of the operation. + + + + Gets a value indicating whether the auto height feature is enabled. + + false always. + + + + Gets or sets the caption displayed in the control and settings used to paint the caption. + + A PictureEditCaption object that specifies the caption itself and settings used to paint it in the control. + + + + Fires when a context button is clicked. + + + + + Provides access to the settings applied to the context buttons displayed in the control, and panels containing these buttons. + + A ContextItemCollectionOptions object that comprises settings applied to the context buttons displayed in the control, and panels containing these buttons. + + + + Provides access to the collection of context buttons displayed in the control. + + A ContextItemCollection object that represents the collection of context buttons displayed in the control. + + + + Fires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes. + + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Gets or sets the height of the picture editor when it works as an inplace control. + + An integer value specifying the height in pixels of an inplace picture editor. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A object identifying the class name of the corresponding editor. + + + + Gets or sets whether the LOD (Level-of-detail) algorithm is used to optimize the display of large images. + + true if the LOD (Level-of-detail) algorithm is used to optimize the display of large images; otherwise, false. + + + + Gets or sets an image displayed when an error occurs during an asynchronous image load. + + The image displayed when an error occurs during an asynchronous image load. + + + + Provides access to properties that allow you to assign and customize an image displayed when an error occurs during an asynchronous image load. + + A DevExpress.XtraEditors.Repository.PictureEditImageOptions object that stores properties that allow you to assign and customize an image displayed when an error occurs during an asynchronous image load. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Returns how the picture is aligned in the control. + + An enumeration value that specifies how the picture is aligned in the control. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Occurs after the value of the PictureEdit.Image property has been changed. + + + + + Fires when the Image Editor dialog is closed. + + + + + Fires when the Editor dialog is about to be opened. Allows you to customize the dialog and its graphic commands. + + + + + Allows you to execute actions when a user loads a file via the control’s context menu. You can handle this event to perform image preprocessing or to load images stored in unsupported formats. + + + + + Allows you to execute actions when a user saves the current image via the control’s context menu. You can handle this event to perform image preprocessing or to save the image to a custom image format. + + + + + Gets or sets an image displayed during an asynchronous image load. + + An image displayed during an asynchronous image load. + + + + Provides access to properties that allow you to assign and customize an image displayed during an asynchronous image load. + + A DevExpress.XtraEditors.Repository.PictureEditImageOptions object that stores properties that allow you to assign and customize an image displayed during an asynchronous image load. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires when an asynchronous image load operation is completed, been canceled, or raised an exception. + + + + + Gets or sets a custom filter for the Open File dialog. + + The Open File dialog’s custom filter. If this property is set to an empty string, the dialog uses a default filter. + + + + Gets or sets the index of the filter currently selected in the Open File Dialog. See this property description for more information: . + + + + + Contains settings that customize the Image Editor dialog. + + The object that contains settings for the Editor dialog’s customization. + + + + Provides access to settings that enable masked mode and allow you to customize the masked mode behavior. + + An object whose settings allows you to enable masked mode and customize the masked mode behavior. + + + + Gets or sets the amount of space, in pixels, between the control’s borders and its content. + + A object that contains inner indents between the control’s borders and its content. + + + + Gets or sets the alignment of the image within the picture editor. + + A enumeration value specifying the image alignment. + + + + Gets or sets how an image is scaled. + + A value that specifies how an image is scaled. + + + + Gets or sets how the editor stores the image pasted via the editor’s context menu. + + A value representing how an image loaded via the editor’s context menu is stored in the edit value. + + + + Fires when the context menu is about to be displayed. + + + + + Gets an object providing properties specific to a picture edit control. + + A object instance providing settings common to a picture edit control. + + + + Gets or sets a custom filter for the Save File dialog. + + The Save File dialog’s custom filter. If this property is set to an empty string, the dialog uses a default filter. + + + + Gets or sets the index of the filter currently selected in the Save File Dialog. See this property description for more information: . + + + + + Gets or sets whether the context menu contains a command that allows an end user to take a picture from a webcam. + + A DevExpress.XtraEditors.Controls.CameraMenuItemVisibility enumeration value that specifies whether the context menu contains a command that allows an end user to take a picture from a webcam. + + + + Gets or sets whether the control’s context menu contains the Edit command that invokes the Image Editor. The Image Editor allows users to perform basic edit operations and then save the result back to the PictureEdit control. + + DefaultBoolean.True if the Edit menu command is available; DefaultBoolean.Default or DefaultBoolean.False if the Edit menu item is hidden. + + + + Gets or sets a value indicating whether the context menu is displayed when the picture editor is right-clicked. + + true if the context menu is displayed when the editor is right-clicked; otherwise, false. + + + + Gets or sets whether scroll bars that allow an end-user to scroll the image are enabled. + + true if scroll bars that allow an end-user to scroll the image are enabled; otherwise, false. + + + + Gets or sets whether the picture editor’s context menu contains zoom-related commands. + + A value that specifies if the picture editor’s context menu contains zoom-related commands. + + + + Gets or sets how the image changes size within the picture editor. + + The displayed image’s size mode. + + + + This field is obsolete (the control no longer detects if in-place image editors are bound to large byte arrays, and does not show related warnings. Note that operations with “byte[]” images can consume a significant amount of resources and may lead to a severe performance penalty). + + + + + Gets or sets the colorization mode for the object’s SVG image. + + Colorization mode. + + + + Gets or sets the required size of the vector image. + + A structure that specifies the required size for rendering the vector image. + + + + Fires when the Take Picture dialog is closed. Allows you to get the dialog result and captured image, and replace this image. + + + + + Fires when the Take Picture dialog is about to be displayed. Allows you to customize the dialog, and specify the camera device and resolution. + + + + + Gets or sets whether the is painted grayed out when it’s in the disabled state. + + true if the control is painted grayed out when it’s in the disabled state; otherwise, false + + + + Gets or sets the factor that adjusts the default zoom speed via the mouse wheel. + + A value that specifies the factor that adjusts the default zoom speed via the mouse wheel. The default is 1. + + + + Gets or sets the factor that adjusts the default zoom speed via the mouse wheel. This property is obsolete. Use the RepositoryItemPictureEdit.ZoomAcceleration property instead. + + A value that specifies the factor that adjusts the default zoom speed via the mouse wheel. The default is 1. + + + + Gets or sets whether the CTRL modifier key should be pressed to zoom pictures with the mouse wheel. + + A ZoomingOperationMode enumeration value that specifies how zooming can be performed using the mouse wheel. + + + + Gets or sets the zoom percentage of the displayed image. + + An integer value that specifies the zoom percentage of the displayed image. The default is 100. + + + + Fires when the RepositoryItemPictureEdit.ZoomPercent property is changed. + + + + + Serves as the base for repository items that provide settings for editors with popup windows. + + + + + Creates an instance of the class. + + + + + Gets or sets a value specifying which editor button will open the editor’s dropdown window. + + A zero-based integer specifying the button by its index within the RepositoryItemButtonEdit.Buttons collection. + + + + Gets or sets whether an editor’s dropdown can be displayed when the editor is in the read-only state. + + A value that specifies if an editor’s dropdown can be displayed in the read-only state. + + + + Gets the appearance settings used to paint the editor’s popup window. + + A object which provides the appearance settings used to paint the editor’s popup window. + + + + Copies settings from the repository item specified as a parameter. + + A descendant representing the repository item whose settings should be copied to the current repository item. + + + + Fires when the editor’s pop-up is about to be displayed. + + + + + Allows you to perform specific actions with respect to how the popup window was closed. + + + + + Enables you to specify whether changes are saved or discarded when closing the popup window. + + + + + Gets or sets the key combination used to open and close the pop-up window. + + A object specifying the key combination used to open and close the popup window. + + + + Fires when a context button is clicked. + + + + + Provides access to the settings applied to the context buttons displayed by editor items. + + A DevExpress.Utils.SimpleContextItemCollectionOptions object that comprises settings applied to the context buttons. + + + + Provides access to the collection of context buttons displayed by editor items. + + A DevExpress.Utils.ContextItemCollection object that represents the collection of context buttons. + + + + Fires when the CheckContextButton.Checked, TrackBarContextButton.Value or RatingContextButton.Rating property value changes. + + + + + Creates a default button when the editor is initialized. + + + + + Allows you to customize the context buttons for individual items. + + + + + Gets the owning editor’s type name. + + The ‘PopupBaseEdit‘ string always. + + + + Gets the editor which owns the current repository item object. + + A editor owning the current repository item. + + + + Occurs after the editor’s popup window has been opened. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the popup window’s border style. + + A enumeration value specifying the popup window’s border style. + + + + Gets or sets the minimum size for the associated dropdown window. + + A structure that specifies the dropdown window’s minimum size. + + + + Sets the popup window’s initial size. + + A Size value. + + + + Gets or sets the popup window’s width. + + An integer value specifying the width of the editor’s popup window. + + + + Gets or sets whether the popup window’s contents are displayed during resize operations. + + A ResizeMode enumeration value that specifies whether the popup window’s contents are displayed during resize operations. The ResizeMode.Default value is equivalent to LiveResize. + + + + Gets an object providing properties specific to the popup control. + + The object providing settings specific to the popup control. + + + + Enables you to specify whether an attempt to close the editor’s popup window will succeed. + + + + + Enables you to specify whether an attempt to open the editor’s popup window will succeed. + + + + + Gets or sets whether the popup window can be opened by clicking the edit box and whether a single or double click is required. + + A enumeration value. + + + + Gets or sets whether the popup window’s shadow is displayed. + + true to display the popup window’s shadow; otherwise, false. + + + + Allows you to suppress mouse events when clicking outside an open popup menu. + + true, to suppress mouse events; otherwise, false. + + + + Contains settings that are common to the descendants of the class. + + + + + Initializes a new instance of the class. + + + + + Copies the settings of the specified repository item. + + A object representing the source of the operation. + + + + Gets or sets whether the popup window is displayed immediately after an end-user has typed a character in the edit box. + + true if the popup window is displayed immediately after an end-user has typed a character in the edit box; otherwise, false. + + + + This member supports the .NET Framework infrastructure and cannot be used directly from your code. + + + + + For internal use. + + + + + Gets the editor which owns the current repository item. + + The control which owns the current repository item. + + + + Gets or sets a value indicating whether the dropdown window is sizeable. + + true if the dropdown is sizeable; otherwise, false. + + + + For internal use. + + + + + Represents a repository item that provides settings for editors. + + + + + Creates and initializes a new instance of the class. + + + + + Gets whether it is allowed to update popup width. + + true if it is allowed to update popup width; otherwise, false. + + + + Copies settings and event handlers from the repository item specified as a parameter. + + A descendant representing the repository item whose settings are to be copied to the current item. + + + + Obsolete. Gets or sets whether to close the popup window when another form is opened. + + true if the dropdown is closed when another form is opened; otherwise, false. + + + + Gets or sets whether the current dropdown control must be closed when: + 1) clicking on a control within another form; + 2) clicking outside its bounds, and at the same time, within another non-DevExpress popup window that belongs to the current dropdown control. + + true if the dropdown control is closed on a click outside its bounds; otherwise, false. + + + + Gets the alignment of the editor content when the editor works inplace within a container control. + + The HorzAlignment.Near value always. + + + + Gets the corresponding editor’s type name. + + The ‘PopupContainerEdit‘ string always. + + + + Gets or sets whether this editor automatically focuses a control in its popup window when this window opens. A focused control is the one with the smallest TabIndex property value. + + true to automatically focus a control in the popup; otherwise, false. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Gets or sets the control to display in the popup window. + + A control to display in the popup window. + + + + Gets or sets a value indicating whether end-users can resize the popup window. + + true to allow popup window resizing; otherwise, false. + + + + Gets or sets whether the initial popup width matches the editor or content width. + + A DevExpress.XtraEditors.PopupWidthMode enumeration value, such as ContentWidth or UseEditorWidth, that specifies whether the initial popup width matches the editor or content width. + + + + Gets an object containing properties, methods and events specific to the control. + + The object containing settings for the current control. + + + + Enables you to specify the display text for the editor. + + + + + Fires when closing the popup window, enabling you to specify the editor’s value based on the state of controls residing within the popup. + + + + + Gets or sets a value indicating whether the close button is displayed within the popup window. + + true to display the close button; otherwise, false + + + + Gets or sets whether the text box is visible and enabled. + + A enumeration value specifying text box availability. + + + + Gets or sets whether the accociated popup control’s minimum size is specified by its MinimumSize property. + + true if the popup control’s minimum size is specified by the control’s MinimumSize property; false if the minimum size is specified by the editor’s RepositoryItemPopupBase.PopupFormMinSize property. + + + + Represents a repository item which stores settings specific to a control. + + + + + Creates a new object. + + + + + Gets or sets whether the progress indicator reflects changes using animation. This property is not in effect for in-place editors. + + True if the progress indicator reflects changes using animation; False if not; Default uses the WindowsFormsSettings.AnimationMode global setting. + + + + Not supported. + + false always. + + + + Gets the appearance settings used to paint the editor when it’s enabled. + + An object that provides the appearance setting used to paint the editor when it’s enabled. + + + + Gets the appearance settings used to paint the editor when it’s disabled. + + An object that provides the appearance setting used to paint the editor when it’s disabled. + + + + Gets the appearance settings used to paint the current editor when it’s focused. + + A DevExpress.Utils.AppearanceObject object which provides the appearance setting used to paint the editor when it’s focused. + + + + Gets the appearance settings used to paint the read-only editor. + + A DevExpress.Utils.AppearanceObject object which provides the appearance settings used to paint the read-only editor. + + + + Copies settings of the specified repository item. + + A object representing the source of the operation. + + + + Gets the default horizontal alignment of the editor’s content. + + A enumeration value specifying the editor content’s default horizontal alignment. + + + + Gets the class name of the control corresponding to the current repository item. + + A string value representing the class name of a corresponding editor. + + + + Gets or sets the delay, in milliseconds, between flashes in the flow animation. + + An integer value that specifies the delay, in milliseconds, between flashes in the flow animation. + + + + Gets or sets the time, in milliseconds, that it takes the flash to move through the progress indicator in flow animation. + + An integer value that specifies the duration, in milliseconds, of the flash movement in flow animation. + + + + Gets or sets whether the progress indicator is displayed using flow animation. + + true if the progress indication is displayed using flow animation; otherwise, false. + + + + Obsolete. Use the RepositoryItemProgressBar.FlowAnimationDuration property instead. + + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the control’s maximum value. + + An integer value representing the maximum value. + + + + Gets or sets the control’s minimum value. + + An integer value representing the minimum value. + + + + Gets or sets whether to present the current position as a relative value between the RepositoryItemProgressBar.Minimum and RepositoryItemProgressBar.Maximum and format it as a percentage. The RepositoryItemBaseProgressBar.ShowTitle property must be set to true. + + true to present the current position as a relative value; false to present the current position as an absolute value. + + + + Occurs after the value of the ProgressBarControl.Position property has been changed. + + + + + Gets an object providing properties specific to the ProgressBarControl. + + A object providing settings specific to the progress bar. + + + + Gets or sets a value by which a call to the ProgressBarControl.PerformStep method increases the control’s current position. + + An integer value by which the progress bar’s position changes. + + + + Represents a repository item which stores settings specific to controls. + + + + + Initializes a new class instance with default settings. + + + + + Populates this with items generated from values of the specific enumeration and replaces default item descriptions. + + A Type of enumeration, whose values should be used to generate items. + A Delegate that encapsulates a method which replaces generated items’ captions. + + + + Populates this with items generated from values of the specific enumeration. + + A Type of enumeration, whose values should be used to generate items. + + + + Populates this with items generated from values of the specific enumeration. + + + + + Populates this with items generated from values of the specific enumeration and replaces default item descriptions. + + A Delegate that encapsulates a method which replaces generated items’ captions. + + + + Gets or sets whether the RadioGroup.SelectedIndex and EditValue properties can be out of sync when handling the EditValueChanged event. + + true if the RadioGroup.SelectedIndex and EditValue properties can be out of sync when handling the EditValueChanged event; otherwise, false. + + + + Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. + + true if scrolling via the Mouse Wheel is supported by the editor; otherwise, false. + + + + Copies properties of the source repository item to the current object. + + A object whose settings are assigned to the current object. + + + + Gets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content. + + true if the editor’s height is calculated automatically to fit the editor’s content; otherwise, false. + + + + Gets or sets the indent between the columns of items. This property is in effect if RepositoryItemRadioGroup.ItemsLayout is set to Column (as well as Default), and RepositoryItemRadioGroup.ItemHorzAlignment is set to Near. + + An integer value that specifies the indent between the columns of items. + + + + Gets or sets the number of columns displayed within the radio group editor. This property is in effect in Column layout mode (see RepositoryItemRadioGroup.ItemsLayout). + + An integer value indicating the number of columns. + + + + Gets the default alignment of the editor’s contents when the editor operates as an inplace control. + + The HorzAlignment.Near value. + + + + Gets the owning editor’s type name. + + The ‘RadioGroup‘ string always. + + + + Gets or sets whether the focus rectangle is painted around the radio group when the radio group is focused and no radio item is selected. + + true if the focus rectangle is painted around the radio group when the radio group is focused and no radio item is selected; otherwise, false. + + + + Gets or sets the horizontal distance between adjacent radio items in Flow layout mode (see RepositoryItemRadioGroup.ItemsLayout). + + The horizontal distance between adjacent radio items in Flow layout mode. + + + + Gets or sets the vertical distance between radio items in Flow layout mode (see RepositoryItemRadioGroup.ItemsLayout). + + The vertical distance between radio items in Flow layout mode. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the horizontal alignment of a radio box glyph within a radio group editor. + + A enumeration value specifying the radio box’s horizontal alignment. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or set whether items are aligned at the near edge of the control or justified. + + A DevExpress.XtraEditors.RadioItemHorzAlignment enumeration value that specifies whether items are aligned at the near edge of the control or justified. + + + + Gets the collection of items displayed by the current radio group editor. + + The object representing the collection of items displayed by the editor. + + + + Gets or sets how items are arranged. + + A value that specifies how items are arranged. + + + + Gets or set whether items are aligned at the top edge of the control or justified. + + A DevExpress.XtraEditors.RadioItemVertAlignment enumeration value that specifies whether items are aligned at the top edge of the control or justified. + + + + Gets the editor that owns the repository item. + + A control that owns the repository item. + + + + Gets or sets the amount of empty space between the control’s bounds and radio items. + + A value that specifies the amount of empty space around radio items. + + + + Gets an object providing properties specific to the radio group editor. + + The object providing settings specific to the radio group editor. + + + + Occurs on changing the index of the selected item in the radio group editor. + + + + + Contains settings specific to a editor. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. + + true if scrolling via the Mouse Wheel is supported by the editor; otherwise, false. + + + + Gets the editor’s class name. + + A string that represents the editor’s class name. + + + + Gets or sets a value by which the position of the left or right slider changes when the user presses the PageUp or PageDown key or the / method is called. + + An integer value. + + + + Gets or sets a value by which the position of the left or right slider changes when the user uses arrow keys or the / method is called. + + An integer value. + + + + Gets or sets the string used to format the tooltip displaying the minimum and maximum values of the current range. + + A string value used to format the tooltip displaying the minimum and maximum values of the current range. + + + + Provides access to advanced settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether this ‘s text can be formatted using HTML tags. + + A DefaultBoolean enumerator value that specifies whether or not this ‘s text can be formatted using HTML tags. + + + + Copies all the settings from the target to this . + + A whose properties are to be cloned to this . + + + + Gets or sets whether the height should be calculated automatically. + + true if the height should be calculated automatically; otherwise, false. + + + + Gets or sets whether this should be automatically sized. + + true if this should be automatically sized; otherwise, false. + + + + Occurs when the mouse pointer hovers over a rating scale item and allows you to display a unique hint for that item. + + + + + Gets or sets the this ‘s border style. + + + + + Gets or sets an image, displayed by a item when this item is checked (selected). + + An Image displayed by a item when this item is checked (selected). + + + + Returns the textual representation of the type of the editor that owns this object. + + Return value: RatingControl. + + + + Gets or sets whether partly checked glyphs are enabled. + + A value that specifies the rating precision. + + + + Gets or sets the value assigned to the first item. + + A Decimal value assigned to the first item. + + + + Returns a brick object that contains information on how this should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the regular rating glyph. + + An Image displayed by rating items in their regular state. + + + + Gets or sets the image displayed by hovered items within this . + + An Image displayed by hovered items within this . + + + + Gets or sets whether this measures its rating in the opposite direction. + + true if this measures its rating in the opposite direction; otherwise, false. + + + + Fires whenever an end-user clicks a rating item within this . + + + + + Gets or sets the number of rating items within this . + + An Int32 value that is the number of rating items within this . + + + + Gets or sets the distance between neighboring rating items. + + An Int32 value that is the distance between neighboring rating items. + + + + Occurs when the mouse pointer leaves the rating item’s bounds. + + + + + Occurs when an end-user hovers a rating item within this . + + + + + Gets or sets this ‘s padding. + + A Padding structure that specifies the distance between the borders and this control’s content. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the rating items’ alignment within the . + + A HorzAlignment enumerator value that specifies the rating items’ alignment within the . + + + + Gets or sets the rating item positioning within this . + + An DevExpress.Utils.Drawing.ItemLocation enumerator value that specifies the rating item positioning within this + + + + Gets or sets the rating items’ orientation within the . + + An enumerator value that specifies the rating items’ orientation within the . + + + + Gets or sets whether the text assigned to the RatingControl.Text property should be visible. + + true if the text assigned to the RatingControl.Text property should be visible; otherwise, false. + + + + Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. + + true, to display tooltips; otherwise, false. + + + + Gets or sets the ‘s text position relative to the rating items. + + A DevExpress.XtraEditors.Repository.RatingTextLocation enumerator object that specifies the ‘s text position relative to the rating items. + + + + Gets or sets the distance between the ‘s rating items and this control’s text. + + An Int32 value that specifies the distance between the ‘s rating items and this control’s text. + + + + Gets or sets the difference in two neighboring rating items’ values. + + A Decimal value that is the difference in two neighboring rating items’ values. + + + + An item in an editor container’s repository used to create a . + + + + + Initializes a new instance of the class with the default settings. + + + + + This property is not supported by the class. + + + + + Gets or sets whether a search is automatically performed on typing text. + + true if a search is automatically performed on typing text; otherwise, false. + + + + Copies settings of the specified repository item to the current one. + + A object or its descendant that represents the source of the operation. + + + + Starts the control’s runtime initialization. + + + + + Provides access to the collection of buttons in the current . + + The SearchControlButtonCollection object that represents the collection of objects. + + + + Gets or sets an ISearchControlClient object whose data is filtered using the . + + An DevExpress.Utils.ISearchControlClient object whose data is filtered using the . + + + + Creates the default buttons (Search, Clear and MRU). + + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Ends the control’s runtime initialization. + + + + + This property is not supported by the class. + + + + + Gets or sets the comparison operator (Equals, Starts With, and so forth) used to compare the attached control’s items with the query in the search box. This property is only in effect if the is attached to a . + + An enumeration value that specifies a comparison operator. + + + + Gets or sets the delay for a search performed automatically on typing text. + + A System.Int32 value that specifies the delay for an automatically performed search. + + + + This property is not supported by the class. + + + + + This property is not supported by the class. + + + + + Gets or sets whether the text specified by the RepositoryItemTextEdit.NullValuePrompt property is displayed when the editor contains an empty string. + + true if the text is displayed; otherwise, false. + + + + Gets the editor that owns the current repository item object. + + A editor that owns the current repository item. + + + + This property is not supported by the class. + + + + + Allows you to specify columns in the attached data control where the should search for data. + + + + + Allows users to choose data fields to search in. This property is in effect when the RepositoryItemSearchControl.ShowSearchByButton property is true. + + The list of data fields for users to choose from. + + + + Gets or sets whether the Clear Button is displayed in the + + true if the Clear Button is displayed; otherwise, false. + + + + Gets or sets the mode in which the Search and Clear buttons are displayed. + + A ShowDefaultButtonsMode enumeration value that specifies the mode in which the Search and Clear buttons are displayed. + + + + Gets or sets whether the dropdown button that invokes a list of most recently used search requests is displayed. + + true if the dropdown button that invokes a list of most recently used search requests is displayed; otherwise, false. + + + + Gets or set whether the Search Button is displayed in the . + + true if the Search Button is displayed; otherwise, false. + + + + Allows users to choose data fields to search in. This property is in effect when the RepositoryItemSearchControl.SearchByMembers property contains the fields to search in. + + true, to allow users to choose data fields to search in; otherwise, false. + + + + This property is not supported by the class. + + + + + Contains settings specific to a control. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether the sparkline reflects changes to the chart values using animation. This property is not in effect for in-place editors. + + True if the sparkline reflects changes to the chart values using animation; False if not; Default uses the WindowsFormsSettings.AnimationMode global setting. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Copies settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Overrides the RepositoryItem.AutoHeight property to hide it. + + Always false. + + + + Gets or sets the data source for the control. + + A System.Object class descendant which represents a datasource for a sparkline. + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Gets or sets the name of a data field containing the sparkline’s edit value. + + A string value specifying a field name in the data source. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Specifies the internal space between the editor’s content and its edge, in pixels. + + A value. + + + + Gets or sets the name of a data field containing values for sorting sparkline data points. + + A string value specifying a field name in the data source. + + + + Specifies how data points are sorted. + + A enumeration value. + + + + Gets or sets the name of a data field containing values for sparkline data points. + + A string value specifying a field name in the data source. + + + + Provides access to the range settings. + + A object that specifies range settings for the control. + + + + Gets or sets the view used to represent sparkline data. + + A class descendant. + + + + Represents a repository item which stores settings specific to a control. + + + + + Creates a new object. + + + + + Copies settings of the specified repository item to the current one. + + A object representing the source of the operation. + + + + Gets the default horizontal alignment of the editor contents when the editor works inplace within a container control. + + A enumeration member specifying the default horizontal alignment of the editor’s contents. + + + + Gets or sets an edit mask. + + A string which specifies a mask expression. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A string value representing the class name of a corresponding editor. + + + + Gets or sets the unit value by which the editor’s value changes when a user clicks a spin button or presses the Up Arrow or Down Arrow key. + + A decimal value that specifies the unit value. + + + + Gets or sets whether a user can input decimal or integer numbers only. + + true to allow users to enter decimal values; false to allow users to enter integer values only. + + + + Gets or sets the editor’s maximum value. + + A decimal value representing the editor’s maximum value. + + + + Gets or sets the editor’s minimum value. + + A decimal value representing the editor’s minimum value. + + + + Gets an object providing properties specific to the spin editor. + + A object providing settings specific to the spin editor. + + + + Occurs after the value of the SpinEdit.Value property has been changed. + + + + + Represents a repository item which contains settings specific to editors. + + + + + Creates a new object with default settings. + + + + + Gets or sets whether the context image is changed using animation. This property is not in effect for in-place editors. + + True if the context image is changed using animation; False if not; Default uses the WindowsFormsSettings.AnimationMode global setting. + + + + Gets or sets whether this can colorize its icons. + + A enumerator value that specifies whether or not this can colorize its icons. The DefaultBoolean.Default value is identical to DefaultBoolean.False. + + + + Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. + + true if scrolling via the Mouse Wheel is supported by the editor; otherwise, false. + + + + Gets or sets whether end users can reset the editor’s value to null with the keyboard. + + A value that specifies if end-users can set the editor’s value to a null reference. + + + + Copies properties of the source repository item to the current object. + + The source repository item object. + + + + Gets or sets whether the masked editor should play a system error sound when a user enters an invalid character (for example, a literal in an editor with a Numeric mask). This property replaces the property in v20.2 and newer. + + true, to play a system error sound when a user enters an invalid character; false, to ignore it. + + + + Occurs before the editor’s context menu is displayed. + + + + + Gets or sets the character casing applied to the editor’s content. + + A enumeration value specifying the character casing applied. + + + + Gets or sets a custom image displayed at the editor’s edge, specified by the RepositoryItemTextEdit.ContextImageAlignment property. + + A custom image displayed at the editor’s edge. + + + + Gets or sets the alignment of an image displayed by this editor. + + A DevExpress.XtraEditors.ContextImageAlignment enumerator value that specifies the alignment of an image displayed by this editor. + + + + Provides access to all properties that allow you to assign and customize a custom image displayed at the editor’s edge. + + A DevExpress.XtraEditors.Repository.ContextImageOptions object that stores all properties that allow you to assign and customize a custom image displayed at the editor’s edge. + + + + Allows you to highlight or custom paint strings within the control’s text. This event is supported in Advanced mode (see RepositoryItemTextEdit.UseAdvancedMode). + + + + + Allows you to dynamically supply custom auto-complete text suggestions each time a user types a new word in the text box. This event is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource, and the AutoCompleteMode option is set to SuggestSingleWord. + + + + + Shows the Mask Editor dialog at runtime. Users can utilize this dialog to apply standard or custom masks to this editor. + + The optional parameter that allows you to use a custom value in the preview section of the “Create New Mask…” dialog. + true if a user chose a new mask type or format, false if mask settings were not changed. + + + + Gets the corresponding editor’s type name. + + The ‘TextEdit‘ string always. + + + + Allows you to manually control user edits, and modify them according to your custom logic. + + The Action of the CustomTextMaskInputArgs type that allows you to track and modify user changes, and set up final editor text. + The tag passed to the Action (assigned to the CustomTextMaskInputArgs.Tag property). If not set, the BaseEdit.Tag property value is used. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets whether the selection is hidden when moving focus to another control. + + true if the selection in the editor is hidden when moving focus to another control; otherwise, false. + + + + Specifies the editor’s input mask. From v20.2, use the property to specify an input mask. + + A object that comprises the editor’s mask settings. + + + + Gets or sets the amount of space around the text box embedded in the . + + A System.Windows.Forms.Padding structure that specifies the amount of space around the editor’s text box. + + + + Provides access to settings that allow you to create input masks. This property replaces the property beginning with v20.2. See the following help topic for more information: Input Masks. + + + + + Gets or sets the maximum number of characters an end-user can enter into the editor. + + A positive integer specifying the maximum number of characters end-users can enter. 0 to disable the text length limit. + + + + Gets or sets the maximum number of characters in the automatically generated tooltip displayed for an in-place editor. + + The maximum length of the automatically generated tooltip for an in-place editor. The default is 500. + + + + Gets or sets a grayed out hint displayed when the editor’s value is null or empty. This property is in effect for standalone editors and for editors embedded in toolbars and Ribbon controls. Not supported for in-place editors embedded in grid and tree list controls. Not supported for read-only editors. + + A string that specifies the text displayed grayed out when the edit value is empty. + + + + Gets or sets whether the editor displays a prompt when its value is not specified (equals String.Empty). + + true if the editor displays a prompt when its value is not specified (equals String.Empty); otherwise, false. + + + + Gets an editor which owns the current repository item. + + A control that owns the current repository item. + + + + Gets or sets the padding. The MemoEdit does not fully support this property, use the MaskBoxPadding property instead. + + A System.Windows.Forms.Padding structure that specifies the amount of space between the editor’s text and the border. + + + + Gets or sets the password character that appears instead of actual characters. + + A character that appears instead of actual characters. + + + + Gets an object providing properties specific to the text edit control. + + The object providing settings common to the current edit control. + + + + Reverts all properties to their default values, and removes an active input mask. + + + + + Tests whether the MaskSettings object should be serialized. This member supports the internal .NET infrastructure and does not need to be called from your code. + + + + + + Gets or sets conditions under which this editor should display its null value text (see the NullValuePrompt property). + + Specifies conditions under which this editor should display its null value text. + + + + Gets or sets whether the focused editor displays a prompt when its value is not specified. + + true if the focused editor displays a prompt when its value is not specified; otherwise, false. + + + + Gets or sets whether the read-only editor displays a prompt when its value is not specified. + + true if the read-only editor displays a prompt when its value is not specified; otherwise, false. + + + + Occurs when either the UP or DOWN ARROW key is pressed or the mouse wheel is rotated. + + + + + Switches the editor to Advanced Mode. This mode supports new caret and selection animations, emojis, and embedded labels. You can set up properties from the RepositoryItemTextEdit.AdvancedModeOptions group to choose which Advanced Mode features are enabled. + + Specifies whether Advanced Mode is on. The Default value is identical to False. + + + + Gets or sets whether the editor uses an Input Mask to format its display value when not focused. This property replaces the property beginning with v20.2. + + true, if the editor should use the same mask for display and edit modes; false to use the input mask exclusively for the edit mode. + + + + Gets or sets whether the is grayed out in the read only mode. + + true if the is grayed out in read only mode; otherwise, false. + + + + Gets or sets whether password mode is active and the system password character is used to mask the editor’s text. + + true if password mode is active and the system password character is used to mask the editor’s text; otherwise, false. + + + + Gets or sets whether to raise the RepositoryItem.Validating event on pressing the ENTER key. + + true to raise the RepositoryItem.Validating event on pressing the ENTER key; otherwise, false. + + + + Gets or sets the native Excel format string used to format the editor’s value when exporting to XLSX. This property is in effect in WYSIWYG export mode. + + A string value, representing the XLSX format string. + + + + Stores settings specific to a time editor. + + + + + Creates a new object. + + + + + Gets or sets the index of a button within the button collection which will open the editor’s dropdown window. + + An Int32 value specifying the index of a button within the button collection which will open the editor’s dropdown window. The default is 0. + + + + Gets or sets whether an editor’s dropdown can be displayed when the editor is in the read-only state. + + A value that specifies if an editor’s dropdown can be displayed in the read-only state. +The default value is DefaultBoolean.Default. + + + + Copies settings of the specified repository item to the current one. + + A object representing the source of the operation. + + + + Allows you to perform specific actions with respect to how the popup window was closed. + + + + + Occurs when the editor’s dropdown window starts closing. + + + + + Gets or sets the key combination used to open and close the editor’s dropdown window. + + A object specifying the key combination used to open and close the editor’s dropdown window. + + + + This property is not supported by the class. + + Always true. + + + + Gets or sets the edit mask. + + A string which specifies a mask expression. + + + + Gets the class name of an edit control corresponding to the current repository item. + + A string value representing the class name of a corresponding editor. + + + + Notifies the editor that the initialization has been completed. + + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Gets or sets a value specifying the manner in which the hour is displayed. + + A enumeration member specifying the hour format. + + + + Occurs after the editor’s popup window has been opened. + + + + + This member is not supported. + + A enumeration value specifying the border style of the editor’s dropdown window. + + + + Gets or sets the minimum size of the editor’s dropdown window. + + A structure that specifies the dropdown window’s minimum size. + + + + This member is not supported by the class. + + + + + This member is not supported by the class. + + + + + Gets an object providing properties specific to a time edit control. + + A object providing settings common to a time edit control. + + + + Enables you to specify whether an attempt to close the editor’s popup window will succeed. + + + + + Enables you to specify whether an attempt to open the editor’s popup window will succeed. + + + + + Gets or sets whether the popup window can be opened by clicking the edit box and whether a single or double click is required. + + A enumeration value. + + + + Gets or sets whether the shadow is displayed for the editor’s dropdown window. + + true, to display the shadow for the editor’s dropdown window; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the style in which text is displayed in the time editor’s edit box. + + A enumeration member specifying the editing style. + + + + Gets or sets whether users use spin buttons or tiles in the drop-down panel to edit the time. + + A value that specifies how users edit the time. + + + + Gets or sets a value specifying the format of the value displayed by a TimeEdit. + + A enumeration member specifying the format of the time value. + + + + Gets or sets the maxmum time value that can be specified using the touch-aware dropdown window. + + A structure that specifies the maximum time value. + + + + Gets or sets the step by which minutes increment in the touch-aware time-editing UI . The value of 60 must be multiple of TouchUIMinuteIncrement. + + The number by which minutes increment in the touch-aware time-editing UI. + + + + Gets or sets the minimum time value that can be specified using the touch-aware dropdown window. + + A structure that specifies the minimum time value. + + + + Gets or sets the step by which seconds increment in the touch-aware time-editing UI . The value of 60 must be multiple of TouchUISecondIncrement. + + The number by which seconds increment in the touch-aware time-editing UI. + + + + For internal use. + + + + + Represents a repository item that stores settings specific to the control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether it is allowed to edit days in the time interval. + + true if it is allowed to edit days in the time interval; otherwise, false. + + + + Gets or sets whether it is allowed to edit hours in the time interval. + + true if it is allowed to edit hours in the time interval; otherwise, false. + + + + Gets or sets whether it is allowed to edit milliseconds in the time interval. + + true if it is allowed to edit milliseconds in the time interval; otherwise, false. + + + + Gets or sets whether it is allowed to edit minutes in the time interval. + + true if it is allowed to edit minutes in the time interval; otherwise, false. + + + + Gets or sets whether you can edit seconds in the time interval. + + true if you can edit seconds in the time interval; otherwise, false. + + + + Copies settings from the specified repository item to the current one. + + A object or its descendant that represents the source of the operation. + + + + Gets or sets the custom control to be displayed in the ‘s drop-down panel. + + A DevExpress.XtraEditors.Popup.CustomTimeSpanDropDownControl class descendant that serves as the custom control to be displayed in the ‘s drop-down panel. + + + + Gets the class name of an edit control corresponding to the current repository item. + + The editor’s class name. + + + + Gets or sets whether the event fires when the value changes or after a delay. + + A value that specifies whether the event fires when the edit value changes or after a delay. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Gets or sets the maximum number of days in the time interval. + + An integer value that specifies the maximum number of days in the time interval. + + + + Gets or sets the maximum number of hours of the time interval. + + An integer value that specifies the maximum number of hours of the time interval. + + + + Gets or sets the maximum number of milliseconds of the time interval. + + An integer value that specifies the maximum number of milliseconds of the time interval. + + + + Gets or sets the maximum number of minutes of the time interval. + + An integer value that specifies the maximum number of minutes of the time interval. + + + + Gets or sets the maximum number of seconds of the time interval. + + An integer value that specifies the maximum number of seconds of the time interval. + + + + Gets or sets the maximum value of the TimeSpanEdit.TimeSpan property. + + A <,> enumeration value that specifies the maximum value of the TimeSpanEdit.TimeSpan property. + + + + Gets or sets the minimum number of days in the time interval. + + An integer value that specifies the minimum number of days in the time interval. + + + + Gets or sets the minimum number of hours of the time interval. + + An integer value that specifies the minimum number of hours of the time interval. + + + + Gets or sets the minimum number of milliseconds of the time interval. + + An integer value that specifies the minimum number of milliseconds of the time interval. + + + + Gets or sets the minimum number of minutes of the time interval. + + An integer value that specifies the minimum number of minutes of the time interval. + + + + Gets or sets the minimum number of seconds of the time interval. + + An integer value that specifies the minimum number of seconds of the time interval. + + + + Gets or sets the minimum value of the TimeSpanEdit.TimeSpan property. + + A <,> enumeration value that specifies the minimum value of the TimeSpanEdit.TimeSpan property. + + + + Gets or sets a value that is interpreted as the null value assigned to the TimeSpanEdit.TimeSpan property when TimeSpanEdit.EditValue is set to null or any value that cannot be converted to the TimeSpan type. + + The value regarded as the null value. + + + + Gets the editor that owns the repository item. + + A control that owns the repository item. + + + + Gets or sets whether users use spin buttons or tiles in a drop-down panel to edit the time span. + + A enumeration value that specifies how the time interval can be edited. + + + + The class name of an edit control corresponding to the current repository item. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. + + + + + Represents a repository item which stores settings specific to a control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether smooth slide animation for toggling states is enabled. + + true if smooth slide animation for toggling states is enabled; otherwise, false. + + + + Copies settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + This property is not supported by the control. + + + + + Gets or sets the editor’s total width relative to the width of the editor’s thumb. + + The total width of the editor divided by the thumb width. + + + + Gets the class name of the edit control corresponding to the current repository item. + + A System.String object identifying the class name of the corresponding editor. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Converts a specific edit value to a boolean value. + + An Object that is the value to be checked. + true if the target value corresponds to the “checked” state; false if the value corresponds to the “unchecked” state or is not identified. + + + + Converts a boolean value to the corresponding edit value. + + true, to retrieve the edit value when the editor is “checked”; otherwise, false. + An Object that is the edit value associated with the required boolean value. + + + + Gets or sets the text displayed when the editor’s state is Off. + + A string displayed when the editor’s state is Off. + + + + Gets or sets the text displayed when the editor’s state is On. + + A string displayed when the editor’s state is On. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether the text is visible. + + true if the text is visible; otherwise, false. + + + + Gets or sets the width of the editor’s thumb (in pixels). + + The thumb width. + + + + Fires when the control’s state is changed. + + + + + Gets or sets the custom edit value associated with the “unchecked” editor state. + + An Object that is the custom edit value associated with the “unchecked” editor state. + + + + Gets or sets the custom edit value associated with the “checked” editor state. + + An Object that is the custom edit value associated with the “checked” editor state. + + + + Provides access to the control’s settings. + + + + + Initializes a new instance of the class with the default settings. + + + + + Populates the editor with tokens created based on values of an enumeration. + + The type of an enumeration that is used to create tokens. + true, to skip enumeration constants without explicitly assigned integer values; otherwise, false. + true, to skip enumeration constants that are bit combinations of other constants; otherwise, false. + + + + Populates the editor with tokens created based on values of an enumeration. Allows the created tokens to store the enumeration’s underlying integer constants instead of named constants. + + The type of an enumeration that is used to create tokens. + true if the created tokens should store the enumeration’s underlying integer constants; false if tokens should store named constants. + + + + Populates the editor with tokens created based on values of an enumeration. + + The type of an enumeration that is used to create tokens. + + + + Populates the editor with tokens created based on values of an enumeration. + + An enumeration that is used to create tokens. + + + + Populates the editor with tokens created based on values of an enumeration. Allows the created tokens to store the enumeration’s underlying integer constants instead of named constants. + + true if the created tokens should store the enumeration’s underlying integer constants; false if tokens should store named constants. + An enumeration that is used to create tokens. + + + + Provides access to appearance settings that allow you to customize the drop-down list appearances for this . + + An object that stores appearance settings which allow you to customize the drop-down list appearances for this . + + + + Copies all settings from the target to this object. + + A RepositoryItem whose settings should be copied to this . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. Use the RepositoryItemTokenEdit.AutoHeightMode instead to set whether the should automatically expand based on its current content. + + + + + Gets or sets the control’s auto-hide mode. + + A DevExpress.XtraEditors.TokenEditAutoHeightMode enumerator value that specifies the control’s auto-hide mode. + + + + Fires before the drop-down window is shown. + + + + + Fires before this control’s popup menu is shown. Allows you to customize items within this menu. + + + + + Occurs before the peek panel assigned to this is displayed. + + + + + Gets or sets whether only one or multiple tokens can be selected (checked) simultaneously within this control. + + A DevExpress.XtraEditors.TokenEditCheckMode enumerator value that specifies whether only one or multiple tokens can be selected simultaneously within this control. + + + + Gets or sets whether checked tokens within the related control should be deselected when the editor loses focus. + + true if checked tokens within the related control should be deselected when the editor loses focus; otherwise, false. + + + + Fires after the drop-down window is closed and gets the reason for closure. + + + + + Fires when the drop-down window is about to be closed and allows you to get and update the selected token. + + + + + Occurs each time a token needs to be displayed and allows you to manually draw its background. + + + + + Allows you to re-draw the default token glyph. + + + + + Allows you to re-paint the token text area. + + + + + Gets or sets the custom drop-down control for this . + + A DevExpress.XtraEditors.Popup.CustomTokenEditDropDownControlBase class descendant that serves as the custom drop-down control for this . + + + + Gets or sets an object that stores Tokens. + + An Object that stores Tokens. + + + + Stores the default drop-down list capacity, equal to 7 lines. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Stores the default number of lines (4) a can be expanded to. If a Token Edit needs more than 4 lines to display its content, vertical scroll bar appears. To modify this line count, use the RepositoryItemTokenEdit.MaxExpandLines property. + + + + + Gets or sets whether a ‘s token should be deleted if an end-user clicks this token’s image. + + A enumerator value that specifies whether a ‘s token should be deleted if an end-user clicks this token’s image. + + + + If the Token Edit is connected to a data source, this property specifies which data source field stores visible Token captions. + + The name of the data source field that stores Token captions. + + + + Gets or sets the maximum number of drop-down menu items for this . + + An Int32 value that is the maximum number of drop-down menu items for this . + + + + Gets or sets the way this ‘s drop-down list is displayed. + + A DevExpress.XtraEditors.TokenEditDropDownShowMode enumerator value that specifies the way this ‘s drop-down list is displayed. + + + + Gets or sets whether an end-user can manually enter and validate any desired text within this . + + A DevExpress.XtraEditors.TokenEditMode enumerator value that specifies whether an end-user can manually enter and validate any desired text within this . + + + + Gets the editor’s textual representation. + + Return value: TokenEdit. + + + + Gets or sets the character used to separate the TokenEdit.EditValue property value into multiple text blocks. + + A Char value that is used to separate the TokenEdit.EditValue property value into multiple text blocks. + + + + Gets or sets the type of this ‘s edit value. + + A enumeration value that specifies the type of this ‘s edit value. + + + + Forces the control to finish its initialization. + + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets the maximum number of lines this can occupy. This property is ignored if the editor is used in-place. + + An Int32 value that is the maximum number of lines this can occupy. + + + + Gets or sets the maximum tokens number this control can simultaneously display. + + An Int32 value that is the maximum tokens number this control can simultaneously display. + + + + Gets or sets the initial number of rows displayed by this . + + An Int32 value that is the initial number of rows displayed by this . + + + + Returns a that owns this . + + A that owns this . + + + + Fires after the drop-down window is opened. + + + + + Gets or sets how items within this ‘s popup are filtered. + + A DevExpress.XtraEditors.TokenEditPopupFilterMode enumerator value that specifies how items within this ‘s popup are filtered. + + + + Gets or sets the assigned to this . + + An IFlyoutPanel object assigned to this . + + + + Provides access to the set of properties that specify the peek panel behavior. + + A object that stores the set of properties that specify the peek panel behavior. + + + + Gets or sets whether this ‘s drop-down list should display a size grip. + + true if this ‘s drop-down list should display a size grip; otherwise, false. + + + + Fires when a user enters a new value into a Token Edit that is connected to a data source. Allows you to validate entered values and call data source API to save valid records. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Fires before the drop-down window is closed and allows you to cancel the action. + + + + + Fires before the drop-down window is opened and allows you to cancel the action. + + + + + Occurs when a user clicks the Remove button in the TokenEdit drop-down menu. + + + + + Occurs whenever a token is added or removed to (from) the . + + + + + Provides access to the additional separators collection that are used along with the default separator (the RepositoryItemTokenEdit.EditValueSeparatorChar property) to break the text into separate blocks that are converted into tokens. + + A object that stores this ‘s separators. + + + + Gets or sets whether this control’s drop-down list should be displayed. + + true if this control’s drop-down list should be displayed; otherwise, false. + + + + Gets or sets whether the drop-down window is shown when the user clicks within the edit box. + + or if the TokenEdit shows its drop-down window when the user clicks the edit box; otherwise, . + + + + Gets or sets whether items within this control’s drop-down list should display the ‘remove’ icon. + + true if items within this control’s drop-down list should display the ‘remove’ icon; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + Always false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + Always false. + + + + Gets or sets whether token glyphs should be displayed. + + true if token glyphs should be displayed; otherwise, false. + + + + Occurs after a new token was successfully added to this . + + + + + Occurs when a new token is about to be added to this . + + + + + Occurs when an end-user checks or unchecks a token within the corresponding . + + + + + Fires when a user clicks a token. + + + + + Occurs when an end-user double clicks a token within this . + + + + + Gets or sets the location of token icons relative to token captions. + + A DevExpress.XtraEditors.TokenEditGlyphLocation enumerator value that specifies the location of token icons relative to token captions. + + + + Fires whenever a user focuses a token. + + + + + Occurs when an end-user hovers a token within this . + + + + + Fires when a token loses mouse focus. + + + + + Gets or sets whether or not the RepositoryItemTokenEdit.Tokens collection supports automatic population. + + A DevExpress.XtraEditors.TokenEditTokenPopupateMode enumerator value that specifies whether or not the RepositoryItemTokenEdit.Tokens collection supports automatic population. + + + + Occurs after a token is removed from this . + + + + + Fires when a token is about to be removed from this . + + + + + Provides access to this control’s token collection. + + A DevExpress.XtraEditors.TokenEditTokenCollection object that stores this control’s tokens. + + + + Gets or sets whether this Token Edit Control should be painted using the read-only appearance settings. + + true if this Token Edit Control should be painted using the read-only appearance settings; otherwise, false. + + + + Validates the text entered in the editor. + + + + + Allows you to perform the custom validation on text currently entered in this control. + + + + + Gets or sets a set of validation rules for this . + + TokenEditValidationRules enumerator values that specify validation rules for this TokenEdit. + + + + If the Token Edit is connected to a data source, this property specifies which data source field stores unique Token values. + + The name of a data source field that stores Token values. + + + + Contains settings specific to a editor. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the vertical alignment of the control when the auto-size feature is disabled. + + A value that specifies the control’s vertical alignment. + + + + Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. + + true if scrolling via the Mouse Wheel is supported by the editor; otherwise, false. + + + + Copies the settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Gets or sets a value which specifies whether the editor’s height is automatically calculated to fit its content. + + Always false. + + + + Gets or sets whether the track bar’s size is automatically calculated based on its look and feel settings. + + true to allow a track bar to automatically calculate its size; otherwise, false. + + + + Fires after the value of the RepositoryItemTrackBar.AutoSize property has been changed. + + + + + Allows you to provide custom tooltips for the thumb(s). + + + + + This property is not supported by the class. + + A object. + + + + Gets or sets the distance between a tick and its label. + + An Int32 value that is the distance between a tick and its label. + + + + This property is not supported by the class. + + A object. + + + + Gets the editor’s class name. + + The string that represents the editor’s class name. + + + + Returns a brick object that contains information on how the current editor should be printed. + + A DevExpress.XtraEditors.PrintCellHelperInfo object that provides information on the editor’s state and appearance settings that will be used when the editor is printed. + An object that contains information on how to print the editor. + + + + Gets or sets whether the selected range is highlighted. + + true if the selected range is highlighted; otherwise, false. + + + + Gets or sets whether this track bar should be reversed. + + true if this track bar should be reversed; otherwise, false. + + + + Provides access to appearance settings used to paint the current ‘s labels. + + An ApperanceObject that stores appearance settings for the current ‘s labels. + + + + Provides access to the collection of labels used within the current . + + A TrackBarLabelCollection that stores all labels used within the current . + + + + Gets or sets a value to be added to or subtracted from the current value when you use the PAGE UP and PAGE DOWN keys and the TrackBarControl.MoveLargeLeft orTrackBarControl.MoveLargeRight methods. + + An integer value that specifies the large change. + + + + Gets or sets the editor’s maximum value. + + An integer value which specifies the maximum value for the track bar. + + + + Gets or sets the editor’s minimum value. + + An integer value which specifies the minimum value for the track bar. + + + + This property is not supported by the class. + + A string. + + + + Gets or sets a value that specifies the orientation of the track bar. + + A value that specifies the orientation of the track bar. + + + + Fires when a user changes the trackbar’s value using the mouse or keyboard. + + + + + Gets or sets whether the current ‘s labels are visible. + + true if the current ‘s labels are visible; otherwise, false. + + + + Gets or sets whether hidden ticks should display their labels. + + true if hidden ticks should display their labels; otherwise, false. + + + + Gets or sets whether the track bar shows the current value in a tooltip when a user moves a thumb. + + true if the track bar shows the current value in a tooltip when a user moves a thumb; otherwise, false. + + + + Gets or sets a value to be added to or subtracted from the current value when you use the ARROW keys, mouse wheel and TrackBarControl.MoveLeft/TrackBarControl.MoveRight methods. + + An integer value that specifies the small change. + + + + Gets or sets the way end-users can move this track bar’s thumb backwards or forwards with a specific ‘small change’ value. + + A DevExpress.XtraEditors.Repository.SmallChangeUseMode enumerator value that specifies the way end-users can move this track bar’s thumb backwards or forwards by a specific ‘small change’ value. + + + + Gets or sets a value that specifies the delta between ticks drawn on a track bar. + + An integer value that specifies the delta between ticks. + + + + Gets or sets a value which specifies the location of tick marks within a track bar. + + A value that specifies the location of tick marks within a track bar. + + + + Fires after the value of the TrackBarControl.Value property has been changed. + + + + + Represents the class which stores settings specific to the control. + + + + + Initializes a new instance of the class. + + + + + This member supports the internal infrastructure and cannot be used directly from your code. + + + + + Gets or sets if the RepositoryItemZoomTrackBar.Middle property is in effect. + + true if the RepositoryItemZoomTrackBar.Middle property is in effect; otherwise, false. + + + + Copies the settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Occurs after the ZoomTrackBar control’s pressed button has been released. + + + + + Occurs immediately after the ZoomTrackBar control’s button has been pressed. + + + + + Labels are not supported in s. + + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Labels are not supported in s. + + + + + Labels are not supported in s. + + + + + Gets or sets the value set to the middle tick. + + An Int32 value that is the value set to the middle tick. + + + + Gets or sets the paint style of the control’s scroll thumb. + + A DevExpress.XtraEditors.Repository.ScrollThumbStyle value. + + + + Labels are not supported in s. + + + + + Labels are not supported in s. + + + + + Gets or sets the neighborhood around the middle tick where the thumb, when dragged, automatically snaps to the middle tick value. + + An integer value that specifies the neighborhood around the middle tick where the thumb, when dragged, automatically snaps to the middle tick value. + + + + This property is not supported by the class. + + An integer value. + + + + This property is not supported by the class. + + A value. + + + + Enumerates values that specify how users edit the time (time span) in the and controls. + + + + + The control displays spin buttons that allow users to edit the time (time span). + + + + + + The control displays tiles in a drop-down panel that allow users to edit the time (time span). + + + + + + Represents the range of values. + + + + + Initializes a new instance of the class. + + An integer value that specifies the minimum limit of the range. This value is assigned to the TrackBarRange.Minimum property. + An integer value that specifies the maximum limit of the range. This value is assigned to the TrackBarRange.Maximum property. + + + + Gets the object whose minimum and maximum limits of the range are equal to 0. To determine whether the object is empty, use the TrackBarRange.IsEmpty property. + + + + + Determines whether the current object has the same settings as that of the specified object. + + A object to compare with the current object. + true if the object specified by the parameter has the same settings as that of the current object; otherwise, false. + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + An integer value representing the hash code for the current object. + + + + Gets whether the minimum and maximum limits of the range are equal to 0. + + true if the minimum and maximum limits of the range are equal to 0; otherwise, false. + + + + Gets or sets the maximum limit of the range. + + An integer value that specifies the maximum limit of the range. + + + + Gets or sets the minimum limit of the range. + + An integer value that specifies the minimum limit of the range. + + + + Returns a human-readable string that represents the object. + + A value that represents the object. + + + + A control that allows a user to search and filter data in the attached control. + + + + + Initializes a new instance of the class with the default settings. + + + + + Clears the filter criteria. + + + + + Gets or sets an object through which a search is performed. + + An object through which a search is performed. + + + + Returns the class name of the current editor. + + The string identifying the class name of the current editor. + + + + Gets an object which contains properties, methods and events specific to the . + + A object that contains settings for the . + + + + Allows you to specify columns in the attached data control where the should search for data. + + + + + Fires when the ‘s text is submitted. Handle the event to get or set the search text and condition. + + + + + Sets the filter criteria. + + A string value that is the filter criteria. + + + + Enumerates values that specify when an editor shows a prompt. + + + + + Enables all options. + + + + + A prompt is displayed when the editor is focused and not focused. Disable this option to only display the prompt when the editor is not focused. + + + + + A prompt is displayed when the editor is in the read-only and editable states. Disable this option to only display the prompt when the editor is editable. + + + + + A prompt is displayed when the editor’s value equals String.Empty or null (Nothing in VB). Disable this option to only display the prompt when the editor’s value equals null (Nothing in VB). + + + + + Disables all options. A prompt is only shown for an editable, not focused editor whose value equals null (Nothing in VB). + + + + + A button that can display text and image. Supports DevExpress Application Skins. + + + + + Creates a new object. + + + + + Gets or sets whether the button can be focused. + + true if the button can be focused; otherwise, false. + + + + Gets or sets whether the current icon should be painted with the button’s fore color. + + A DefaultBoolean enumerator value that specifies whether the current ‘s icon should be painted with the button’s fore color. + + + + Gets or sets whether the current ‘s caption can be formatted using HTML-tags. + + true if the current ‘s caption can be formatted using HTML-tags; otherwise, false. + + + + Gets or sets whether the control’s size is automatically calculated based on its contents. + + true if the control’s size is automatically calculated; otherwise, false. + + + + This member is not supported for the control. Use the SimpleButton.AutoWidthInLayoutControl property instead. + + A Boolean value. + + + + Gets or sets whether the control’s width is changed to display the control’s content in its entirety. This property is in effect when the control resides within a . + + true if auto-size mode is enabled; otherwise, false. + + + + Calculates the button size required to fit its content, but not exceeding the maximum and minimum values. + + A System.Drawing.Size object specifying the button size that best fits its content, but does not exceed the maximum and minimum values. + + + + Gets the ‘s view information. + + A DevExpress.XtraEditors.ViewInfo.SimpleButtonViewInfo object that provides view information on all elements. + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A System.Drawing.Size value. + + + + Gets or sets the alignment of the image displayed within the button. + + A enumeration member specifying the image alignment. + + + + Gets or sets the button’s image. + + The button’s image. + + + + Gets or sets the alignment of the image displayed within the button. + + A enumeration member which specifies the image’s alignment. + + + + Gets or sets the index of the image displayed on the button. + + An integer value representing the zero-based index of the image displayed on the button. + + + + Gets or sets the source of images to be displayed within the button. + + An object that is the source of images to be displayed within the button. + + + + Specifies the image alignment relative to the button. + + A value that specifies the alignment of the button’s image. + + + + Provides access to all properties that allow you to assign and customize an icon for this . + + A DevExpress.XtraEditors.SimpleButtonImageOptions object that stores all properties that allow you to assign and customize an icon for this . + + + + Gets or sets how the button’s image is aligned relative to the button’s text. + + An enumeration value that specifies how the button’s image is aligned relative to the button’s text. + + + + Gets or sets the ditance between the button’s image and text. This property is in effect if the button’s image is aligned relative to the text. + + An integer value that specifies the distance, in pixels, between the button’s image and text. + + + + Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current button. + A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). + + A DevExpress.Utils.DxImageUri object that specifies the uniform resource identifier of the image to be displayed in the current button. + + + + Gets or sets whether the dotted focus rectangle is displayed within the when it has focus. + + The value that specifies whether the dotted focus rectangle is displayed within the when it has focus. + + + + Starts the animation of an animated GIF file being displayed in the button. + + + + + Stops animation of an animated GIF file being displayed in the button. + + + + + Gets or sets the text string displayed within the button control. + + A string value representing the button’s caption. + + + + Visualizes data in a highly condensed way, allowing end users to understand and compare values from different sources. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets data provided for the control. + + An array of values. + + + + Gets the class name of the current editor. + + A string that is the class name of the current editor. + + + + Provides access to the editor-specific properties of the control. + + A object. + + + + The editor to edit numeric values using spin buttons. + + + + + Creates a new object with default settings. + + + + + Gets the editor’s class name. + + The string value representing the editor’s class name. + + + + Gets or sets the editor’s value. + + An object representing the editor’s value. + + + + Gets an object containing properties, methods and events specific to the spin edit control. + + A object containing spin editor settings. + + + + Gets or sets the text displayed in the control’s edit box. + + A string value representing the text displayed in the control’s edit box. + + + + Gets or sets a spin editor’s value. + + A decimal value representing the editor’s value. + + + + Occurs after the value of the SpinEdit.Value property has been changed. + + + + + Visualizes a linear process and highlights its current stage. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the control recognizes HTML tags in Content Blocks’, descriptions and captions. + + DefaultBoolean.True if you can use HTML tags to format item descriptions and captions; DefaultBoolean.Default or DefaultBoolean.False if HTML tags are displayed as regular text characters. + + + + Use the StepProgressBar.Appearances property instead. + + This property is hidden. Use the StepProgressBar.Appearances property instead. + + + + Provides access to a number of properties that allow you to set up global appearance settings common to all s and their content blocks. You can override these appearances in individual elements. See the class description for the examples. + + An object that stores item appearance settings. + + + + Gets or sets whether this control automatically adjusts its size to fit the total size of its content. + + true if the control automatically scales depending on its content; otherwise, false. + + + + Begins the StepProgressBar initialization. + + + + + This property is not intended to be used. + + + + + + Returns the minimum size of the control required to show all of its items. The result includes offsets from each of the control’s borders. + + The minimum control size required to display the control content. + + + + Returns the Hit Info object that allows you to determine which Step Progress Bar element is located under the test point. + + Coordinates of the test point. + The Hit Info object related to the test point. + + + + Specifies the width of all connectors (lines that connect neighboring items). See the class description for information on other available connector settings. + + The connector line width. + + + + Allows you to choose one of nine predefined positions where the control should place its items. + + The alignment position. + + + + Allows you to custom draw an item’s connector. + + + + + Allows you to custom draw an item’s content blocks. + + + + + Allows you to custom draw indicators. + + + + + Gets or set the distance between the content block caption, description, and image. + + The indent between content block elements. + + + + Gets or sets the control dock style. + + The control dock style. + + + + Gets or sets whether the control should draw connectors between neighboring items. See the class description for information on other available connector settings. + + true, to draw connector lines; otherwise, false. + + + + Finishes the Step Progress Bar initialization. + + + + + Returns an item with the given index inside the StepProgressBar.Items collection. + + The item index within the StepProgressBar.Items collection. + The item that occupies a given position. + + + + Retrieves the size of a rectangular area that fits the control. + + The custom-sized area for a control. + The size that fits the control. + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + Gets or sets an image collection ( or ) assigned to this control. Once an image collection is assigned, you can use the ImageIndex or SvgImageIndex properties inside ImageOptions property sections to assign icons stored in these collections to elements. + + An image collection that stores element images. + + + + The distance between neighboring items. This value can change dynamically depending on the actual control size and selected StepProgressBar.LayoutMode. + + + + + Gets or sets the outline width of item indicators. The outline width is zero if the item DrawMode (see StepProgressBarIndicatorOptions.ActiveStateDrawMode and StepProgressBarIndicatorOptions.InactiveStateDrawMode properties) equals None. See the class description for information on other available indicator settings. + + The outline width. + + + + Gets the distance between the item indicator and content blocks on both indicator sides. + + The distance between item indicator and content blocks. + + + + Gets or sets whether the control is flipped horizontally (or vertically, if its StepProgressBar.Orientation is Vertical). + + true if the control is flipped; otherwise, false. + + + + Occurs when users click on the step progress bar item’s hyperlink. + + + + + Provides access to settings that affect all items owned by this control. You can override these global settings for individual items: use the StepProgressBarItem.Options property. + + + + + Occurs when an item’s Progress property is changed. + + + + + Stores objects owned by this control. + + + + + Gets or sets the item arrangement strategy. + + Specifies the way the control arranges its items. + + + + Gets or sets text that displays when it has no items. + + Text that displays when it contains no items. + + + + Allows you to choose between vertical and horizontal control orientation. + + The control orientation mode. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. + + + + + Indicates the progress style of items. + + + + + Gets or sets the scrollbar style. Step Progress Bar displays a scroll bar when its LayoutMode setting is Fixed, and there is not enough space to display all of the control items. + + The scrollbar style. + + + + When the StepProgressBar.LayoutMode property equals “Fixed”, items can be displayed outside the current visible region. The control displays a scroll bar that allows users to access these items. The ScrollToItem method allows you to scroll the control up or down to make a specific item visible. + + An item that should be visible in the current client area of a control. + + + + Switches all items to the Active state. + + + + + Gets the last active (selected) item. + + The last active item. + + + + Fires when the selection moves to another item. + + + + + Gets or sets the last active (selected) control item. Items are addressed by their xref:StepProgressBar.Items collection indexes. When you activate an item, the control automatically activates all items that preceed it. Set to -1 to deactivate all control items. + + The Items collection index of the last active (selected) item, or -1 if there are no active items. + + + + Selects this item, and all items that preceed it. + + The last selected item. + + + + Moves the selection one item further. + + + + + Moves the selection one item back. + + + + + Gets or sets whether to add a glow effect to the indicators and connectors. + + Specifies whether to apply the glow effect to active elements, inactive elements, or both active and inactive elements. + + + + For internal use. + + + + + Unselects (deactivates) all control items. + + + + + Gets or sets whether this control employs DirectX Hardware Acceleration. + + DefaultBoolean.True if the control uses the DirectX rendering. DefaultBoolean.False if the control uses regular GDI rendering. DefaultBoolean.Default if the control uses the rendering engine selected for the entire project. + + + + Contains settings that affect all items owned by this Step Progress Bar. To override these settings for individual items, use the StepProgressBarItem.Options property. + + + + + Gets or sets the maximum width of text strings in both content blocks. If a content block has a text string that is wider than this property value, the string is clipped. Note that the total width of a content block can be larger than the MaxTextWidth property value since content blocks can also display images. + + The maximum content block text width. + + + + Gets or sets the minimum width of text strings in both content blocks. If your items dynamically change content block text, set this property to match the widest text string. This way, you can force these items to remain static and prevent them from flickering. + + The minimum width of text strings in item content blocks. + + + + Stores item indicator settings. These settings can be accessed on both control (StepProgressBar.ItemOptions.Indicator) and item (StepProgressBar.Options.Indicator) levels. + + + + + Gets or sets the indicator draw mode. This mode is in effect when the item is in the Active state. + + The indicator draw mode. + + + + Gets or sets the indicator image. This image is displayed only when the item is in the Active state. + + Provides access to properties that allow you to set up raster or vector images. + + + + Gets or sets whether transparent pixels around the indicator’s image are trimmed. + + True or Default if the transparent pixels around the image are trimmed; otherwise, False. + + + + Gets or sets the indicator draw mode. This mode is in effect when the item is in the Inactive state. + + The indicator draw mode. + + + + Gets or sets the indicator image. This image is displayed only when the item is inactive. + + Provides access to properties that allow you to set up raster or vector images. + + + + Gets or sets the item indicator diameter. + + The item indicator diameter. + + + + An item that visualizes a progress milestone or step. A control stores progress items in the StepProgressBar.Items collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + The StepProgressBarItem.ContentBlock2 caption. + + + + Provides access to appearance settings for this item. + + Stores item appearance settings. + + + + Provides access to the first content block of this item. + + The item’s first content block. + + + + Provides access to the second content block of this item. + + The item’s second content block. + + + + Returns the next item. + + The next item. null if the current item is the last item. + + + + Returns the previous item. + + The previous item. null if the current item is the first item. + + + + Returns the current item state. + + true if the item is active (selected); otherwise, false. + + + + Indicates whether the item is the first item in the step progress bar items collection. + + true if the item is the first item in the step progress bar items collection; otherwise, false. + + + + Indicates whether the item is the last item in the step progress bar items collection. + + true if the item is the last item in the step progress bar items collection; otherwise, false. + + + + Gets or sets the item name. + + The item name. + + + + Provides access to properties that allow you to override global item settings specified in the StepProgressBar.ItemOptions section. + + An object that stores item settings. + + + + Gets or sets the current progress towards this item. + + The progress towards this item. A value between 0 and 100. + + + + Occurs when a specific item’s Progress property is changed. + + + + + Gets or sets whether this item is active (selected). To activate an item, you can also use StepProgressBar.SelectedItemIndex, StepProgressBar.SelectItem(StepProgressBarItem), and StepProgressBar.SelectNext() / StepProgressBar.SelectPrevious() properties and methods. + + Specifies whether this item is active (selected). + + + + Occurs when the item state changes from Active to Inactive, or vice versa. + + + + + Gets or sets a custom object associated with the current item. + + The custom object associated with the item. + + + + A content block displayed on either side of a ‘s indicator. + + + + + Initializes a new instance of the class with specified settings. + + An item that owns this content block. + + + + Allows you to assign a vector or raster image that this content block shows when a parent item is Active. + + Provides access to image-related settings. + + + + Provides access to content block appearance settings. See the class description for information on how to set up item appearance settings at different levels. + + Stores content block appearance settings. + + + + Gets or sets the content block caption. + + The content block caption. + + + + Gets or sets the content block description. + + The content block description. + + + + Disposes of this object and releases all the resources it occupies. + + + + + Allows you to assign a vector or raster image that this content block shows when a parent item is Inactive. + + Provides access to image-related settings. + + + + Returns whether this content block has no content. + + true if this block does not have a caption, description, or image; otherwise, false. + + + + Returns a string representing the current object. + + A String value that represents the current object. + + + + Supplies data for the event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets if the hyperlink is displayed in the content block’s caption (Caption). + + true if the hyperlink is displayed in the content block’s caption (Caption); otherwise, false. + + + + Gets if the hyperlink is displayed in the content block’s description (Description). + + true if the hyperlink is displayed in the content block’s description (Description); otherwise, false. + + + + Specifies the item that contains the hyperlink. + + Returns the item that contains the hyperlink. + + + + Gets the clicked hyperlink’s content block. + + The clicked hyperlink’s content block. + + + + Stores item settings. These settings affect one individual item (if you access them from the StepProgressBarItem.Options property), or all items owned by this control (StepProgressBar.ItemOptions). + + + + + Gets or sets the distance (in pixels) between the end of connector lines, and the item indicator outline. + + The gap between connectors and outline. + + + + Provides access to settings that affect item indicator(s). + + Stores settings that affect item indicator(s). + + + + Lists values that specify whether to add a glow effect to active elements, inactive elements, or both active and inactive elements. + + + + + Apply the glow effect to active elements. + + + + + Apply the glow effect to active and inactive elements. + + + + + Apply the glow effect to inactive elements. + + + + + Do not apply the glow effect. + + + + + Allows you to manage appearance settings and paint styles of multiple editors and controls in a centralized way. This component is deprecated. + + + + + Creates a new object. + + + + + Initializes a new instance of the class with the specified container. + + The which contains the created style controller. + + + + Provides the appearance settings used to paint target controls and editors in the normal state. + + The appearance settings used to paint the target controls and editors in the normal state. + + + + Provides the appearance settings used to paint target editors when they are disabled. + + The appearance settings used to paint target editors when they are in the disabled state. + + + + Provides the appearance settings used to paint the popups of target dropdown editors. + + The appearance settings used to paint the popups of target dropdown editors. + + + + Provides the appearance settings used to paint the popup window’s header panel for target and controls. + + The appearance settings used to paint the popup window’s header panel for target DateEdit and LookUpEdit controls. + + + + Provides the appearance settings used to paint a target editor when it is focused. + + The appearance settings used to paint a target editor when it is focused. + + + + Provides the appearance settings used to paint target editors when they are in the read-only state. + + The appearance settings used to paint read-only editors. + + + + Performs specific actions before control initialization. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Gets or sets the bound controls’ border style. + + The enumerator. + + + + Gets or sets the button style for target editors with embedded buttons. + + The button style for editors with embedded buttons. + + + + Performs specific actions after the control has been initialized. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Allows you to customize the look and feel settings for target controls. + + A object. + + + + Gets or sets the popup border style of target dropdown editors. + + The popup border style of target dropdown editors. + + + + Fires immediately after any property value has been changed. + + + + + Serves as a base for classes that implement style conditions. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value which specifies the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + A which identifies the current style condition object. This value is assigned to the StyleFormatConditionBase.Tag property. + A DevExpress.Utils.AppearanceDefault object which provides the appearance settings used to paint the elements which match the specified format condition. This value is assigned to the StyleFormatConditionBase.Appearance property. + A which represents the first comparison value. This value is assigned to the StyleFormatConditionBase.Value1 property. + A which represents the second comparison value. This value is assigned to the StyleFormatConditionBase.Value2 property. + A value which represents a column whose values are used in conditional formatting. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value which specifies the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + A which identifies the current style condition object. This value is assigned to the StyleFormatConditionBase.Tag property. + A object which provides the appearance settings used to paint the elements which match the specified format condition. This value is assigned to the StyleFormatConditionBase.Appearance property. + A which represents the first comparison value. This value is assigned to the StyleFormatConditionBase.Value1 property. + A which represents the second comparison value. This value is assigned to the StyleFormatConditionBase.Value2 property. + A value which represents a column whose values are used in conditional formatting. + + + + Gets or sets the appearance settings used to paint the elements (e.g., cells in the XtraGrid) that match the specified format condition. + + A object that provides the appearance settings used to paint the elements that match the specified format condition. + + + + Provides access to appearance settings used to paint the descriptions of the items that match the current format condition. + + An object that stores appearance settings used to paint the descriptions of the items that match the current format condition. + + + + Copies the settings from the object passed as the parameter. + + A object or descendant which represents the source of the operation. + + + + Checks whether the specified value in the specified column and data row matches the current style condition. + + An object that represents a column. + An object that represents the tested value. + An object that refers to a target row. + true if the specified value in the specified column and row matches the current style condition; otherwise, false. + + + + This method is obsolete. Use the CheckValue overload that takes the row parameter. + + + + + Gets the collection that owns the current style condition object. + + A object representing the collection which owns the current object. + + + + Gets or sets the comparison operation used by the style condition object. + + A enumeration value which specifies the comparison operation. + + + + Gets or sets whether the current condition is in effect. + + true if the current condition is in effect; otherwise, false. + + + + Gets or sets the Boolean expression. When it evaluates to true, the StyleFormatConditionBase.Appearance is applied to data. The Expression property is in effect when the StyleFormatConditionBase.Condition property is set to FormatConditionEnum.Expression. + + A string that specifies the Boolean expression. + + + + Gets a value indicating whether the current style format condition is enabled. + + true if the StyleFormatConditionBase.Condition property isn’t set to the FormatConditionEnum.None value; otherwise, false. + + + + Gets or sets the object’s name. + + A value that represents the object’s name. + + + + Gets or sets a value which identifies the current style condition object. + + A which identifies the current style condition object. + + + + Returns the text representation of the current object. + + A text representation of the current object. + + + + Gets or sets the first comparison value. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A which represents the comparison value. + + + + Gets or sets the second comparison value. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + A which represents the comparison value. + + + + Initializes a new instance of the class. + + + + + Copies all settings from the object passed as the parameter and assigns them to the current object. + + The object whose settings are assigned to the current object. + + + + Returns a string representing the current object. + + A String value that represents the current object. + + + + Initializes a new instance of the class. + + + + + Copies all settings from the object passed as the parameter and assigns them to the current object. + + The object whose settings are assigned to the current object. + + + + Initializes a new instance of the class. + + + + + Copies all settings from the object passed as the parameter and assigns them to the current object. + + The object whose settings are assigned to the current object. + + + + Gets or sets whether the row automatically adjusts its height to display its entire content. + + true if the row automatically adjusts its height to fit its contents; otherwise, false. + + + + The single-line text editor. + + + + + Initializes a new class instance with default settings. + + + + + Appends the specified string to . + + A string to append to the edit value (text). + + + + Gets or sets the editor’s background color. + + The editor’s background color. + + + + This property isn’t used. + + + + + This property isn’t used. + + + + + A text block. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets a value indicating whether the previous edit operation can be undone. + + true if the previous edit operation can be undone; otherwise, false. + + + + Clears the text and sets the propety to null (Nothing in Visual Basic). + + + + + Hides a drop-down list with auto-complete suggestions. + + + + + Copies the current selection to the Clipboard. + + + + + Allows you to highlight or custom paint strings within the control’s text. This event is supported in Advanced mode (see RepositoryItemTextEdit.UseAdvancedMode). + + + + + Allows you to supply custom auto-complete text suggestions dynamically each time a user types a new word in the text box. This event is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource, and the AutoCompleteMode option is set to SuggestSingleWord. + + + + + Moves the current selection in the text box to the Clipboard. + + + + + Clears text box selection. + + + + + Gets the editor’s class name. + + The ‘TextEdit‘ string + + + + For internal use. + + A Boolean value. + + + + Retrieves the character that is closest to the specified location within the control. + + The location (relative to the control’s top left corner) from which to find the nearest character. + The character closest to the specified location. + + + + Retrieves the index of the character closest to the specified location. + + The location (relative to the control’s top left corner) from which to find the nearest character. + The zero-based index of the character closest to the specified location. + + + + Retrieves the index of the first character of a given line. + + The zero-based index of the target displayed line. + The zero-based index of the first character in the specified line. + + + + Retrieves the index of the first character of the current line. + + The zero-based index of the first character in the current line. + + + + Retrieves the index of the displayed line that contains the specified character. + + The zero-based index of the target character. + The zero-based number of the displayed line in which the character index is located. + + + + Retrieves a point (relative to the control’s top left corner) at which the specified character is displayed. + + The index of the character for which to retrieve the location. + The character’s location relative to the control’s top left corner. + + + + For internal use. + + A Boolean value. + + + + Gets whether the editor is active. + + true if the editor is active; otherwise, false. + + + + For internal use. + + A Boolean value. + + + + Returns a value indicating whether a particular key will be processed by the editor or passed to its container. + + A enumeration value which specifies the key to process. + true if the pressed key will be processed by the editor; otherwise, false. + + + + This member supports the internal editors library infrastructure and is not intended to be used from your code. + + true if a container needs to focus the editor; otherwise, false. + + + + Gets the text box that provides text editing functionality, or null (Nothing in VB.NET) if the editor is in Advanced Mode. + + A DevExpress.XtraEditors.TextBoxMaskBox object that represents the editor’s text box. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. + + + + + Replaces the current selection in the text box with the contents of the Clipboard. + + + + + Gets an object containing this editor’s settings. + + A object containing this editor’s settings. + + + + Supplies data for the event. + + + + + Resets selection and caret position in the editor. + + + + + Clears the selection. + + + + + Scrolls the editor’s content to the current caret position. + + + + + For internal use. + + + + + Initializes a new instance of the class. + + + + + Selects the specified number of characters in the text box starting from the point specified. + + An integer value specifying the selection’s start point in the text box. + An integer value specifying the number of characters to select in the text box. + + + + Selects all text within the text box. + + + + + Gets or sets a value that indicates the selected text in the editor. + + A string value representing the selected text. + + + + Gets or sets the number of characters selected in the text box. + + An integer value specifying the number of characters selected in the text box. + + + + Gets or sets the starting point of text selected in the text box. + + An integer value specifying the starting point of text selected in the text box. + + + + Invokes a drop-down list with auto-complete suggestions. + + + + + Occurs when either the UP or DOWN ARROW key is pressed or the mouse wheel is rotated. + + + + + Gets or sets a value indicating whether the user can focus this control using the TAB key. + + true if the user can focus the editor using the TAB key; otherwise, false. + + + + Gets or sets the text displayed in the edit box. + + A value which specifies the editor’s text. + + + + Undoes the last edit operation in the text control. + + + + + Forces the control to update its text highlight and custom painting that you perform with the TextEdit.CustomHighlightText and RepositoryItemTextEdit.CustomHighlightText events. + + + + + Exposes settings that toggle individual features of the TextEdit Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + + + + Initializes a new instance of the class with specified settings. + + A repository item that owns this object. + + + + Gets or sets whether an editor should use updated caret animations when in Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + Specifies whether update caret animation effects are enabled. + + + + Gets or sets whether an editor should use updated selection animations when in Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + Specifies whether updated selection animation effects are enabled. + + + + Copies all settings from the target TextEditAdvancedModeOptions class instance. + + The object whose settings should be copied. + + + + Gets or sets a custom collection of auto-complete suggestions. This property is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource. + + The TextEdit’s custom string collection source. + + + + Gets or sets text auto-completion mode. This property is in effect if the RepositoryItemTextEdit.UseAdvancedMode option is enabled. + + The text completion behavior of the TextEdit. + + + + Gets or sets the source of auto-complete suggestions. This property is in effect if the RepositoryItemTextEdit.UseAdvancedMode option is enabled. + + The auto-complete source type. + + + + Gets or sets the caption of the embedded editor label. TextEdit-based editors can have embedded labels only when in Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + The embedded editor label’s caption. + + + + Gets the appearance settings of the embedded caption. This property is in effect if the property is enabled. + + An object that contains the appearance settings. + + + + Gets or sets the selection color. This property is in effect if the property is enabled. + + The selection color. + + + + Gets the appearance settings of the embedded caption. This property is in effect if the property is enabled. + + An object that contains the appearance settings. + + + + Gets or sets whether to enable keyboard shortcuts for the editor. This property is in effect if the RepositoryItemTextEdit.UseAdvancedMode option is enabled. + + true to enable keyboard shortcuts; otherwise, false. + + + + Converts this TextEditAdvancedModeOptions object to a string. + + The converted TextEditAdvancedModeOptions object. + + + + Gets or sets whether an editor uses the DirectX Hardware Acceleration. DirectX is required to support some of the unique editor features available when this editor is in Advanced Mode. See this property for more information about this mode: RepositoryItemTextEdit.UseAdvancedMode. + + Specifies whether the editor uses the DirectX or traditional GDI renderer. + + + + Enumerates values that specify auto-complete mode for text editors. + + + + + The editor automatically completes the first entered word in the edit box. The editor uses the first matching suggestion from a source of suggestions. + + + + + Text auto-completion is disabled. + + + + + The editor displays a drop-down list with suggestions when a user types the first word in the edit box. + + + + + The editor uses a combination of the Append and Suggest options — it automatically completes the first word in the edit box, and displays a drop-down list with suggestions. + + + + + The editor displays a drop-down list with custom suggestions every time a user types a new word in the edit box. The editor automatically sets the AutoCompleteSource option to CustomSource in SuggestSingleWord mode. Use the CustomizeAutoCompleteSource event, or AutoCompleteCustomSource collection to specify the custom auto-complete suggestions. + + + + + Contains data for the TextEdit.CustomHighlightText and RepositoryItemTextEdit.CustomHighlightText events. + + + + + Initializes a new instance of the class with specified settings. + + + + + Highlights or custom paints a text block at a specified position. + + A zero-based start index of the target text block. + The length of the text block. + Allows you to specify display settings or a custom painter for the text block. + + + + Highlights a text block at a specific position using custom foreground and background colors. + + A zero-based start index of the target text block. + The length of the text block. + A custom foreground color used to paint the text block. + A custom background color to paint the text block. + + + + Highlights a text block at a specified position using a custom foreground color. + + A zero-based start index of the target text block. + The length of the text block. + A custom foreground color used to paint the text block. + + + + Highlights or custom paints all text blocks that have the specified content. + + A string that identifies target text blocks to highlight or custom paint. + Allows you to specify display settings or a custom painter for the text blocks. + An object that specifies text comparison settings used to locate target text blocks. + + + + Highlights all text blocks that have specified content using custom foreground and background colors. + + A string that identifies target text blocks. + A custom foreground color used to paint the text block. + A custom background color used to paint the text block. + An object that specifies text comparison settings used to locate target text blocks. + + + + Highlights all text blocks that have the specified content using a custom foreground color. + + A string that identifies target text blocks to be highlighted or custom painted. + A custom foreground color used to paint text blocks. + An object that specifies text comparison settings used to locate target text blocks. + + + + Highlights or custom paints whole words. + + The text of target words. + Allows you to specify display settings or a custom painter for the target words. + An object that specifies text comparison settings used to locate target words. + + + + Highlights whole words using custom foreground and background colors. + + The text of target words. + A custom foreground color to paint the target words. + A custom background color to paint the target words. + An object that specifies text comparison settings used to locate target words. + + + + Highlights whole words using a custom foreground color. + + The text of target words. + A custom foreground color used to paint the target words. + An object that specifies text comparison settings used to locate target words. + + + + Gets the zero-based index of the currently processed text line for multi-line text. Returns 0 for single-line text. + + The zero-based index of the currently processed text line. + + + + Gets the currently processed text/text line (for multi-line text). + + The currently processed text/text line. + + + + Gets the position of the currently processed text line within the editor’s text. + + A zero-based index of the currently processed text line within the editor’s text. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets the caret position in the current line. + + The caret position in the current line. + + + + Allows you to specify custom auto-complete suggestions for the current word (EditingWord). + + An array of custom auto-complete suggestions. + + + + Gets the current word that the user is typing. + + The word the user is typing. + + + + Gets or sets whether to display custom suggestions (CustomSource) in the drop-down list as is, or to filter this list to display only those items in the drop-down that start with the current word being edited (EditingWord). + + true to display the custom suggestion list as is; false to filter the custom suggestion list to display only those items that start with the current word being edited (EditingWord). + + + + Gets the current line index (in a multi-line text editor). + + The zero-based index of the current line. + + + + Gets the text displayed in the current line. + + The current line’s text. + + + + The control that manages Windows UI-inspired tiles. Using this component, you can create both static and animated live tiles in your applications. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets whether the disabled state of the is indicated in a specific manner. + + true if the disabled state of the is indicated in a specific manner; otherwise, false. + + + + Gets or sets if a s runtime dragging is enabled. + + true if a s runtime dragging is enabled; otherwise, false. + + + + Gets or sets whether drag-and-drop of tiles between groups is enabled. + + true if drag-and-drop of tiles between groups is enabled; false if an end-user can only drag tiles within the same group. + + + + Gets or sets whether glyphs in tiles should be painted using the tile foreground colors. + + true if glyphs in tiles should be painted using the tile foreground colors; otherwise, false. + + + + Gets or sets whether s within the current are highlighted during s drag-and-drop. + + true if s within the current are highlighted during s drag-and-drop; otherwise, false. + + + + Gets or sets if HTML text formatting is enabled for all tile items within the current . + + A enumerator value that indicates if HTML text formatting is enabled for all tile items within the current . The DefaultBoolean.Default value acts the same as the DefaultBoolean.True value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets if the item hover feature is enabled. + + true if items hover feature is enabled; otherwise, false. + + + + Gets or sets if s within the current can be selected. + + true if s within the current can be selected; otherwise, false. + + + + Gets or sets whether or not a selection border should be drawn around the currently selected tile. + + true if a selection border should be drawn around the currently selected tile; otherwise, false. + + + + Gets or sets whether or not smooth pixel scrolling is enabled for this . + + true if pixel scrolling is enabled; otherwise, false. + + + + Gets or sets whether this should play initial animation the first time it is displayed. + + true if this should play initial animation the first time it is displayed; otherwise, false. + + + + Gets or sets an object that specifies appearance settings used to highlight s within the current . + + A GroupHighlightingProperties object that contains appearance settings used to highlight s within the current . + + + + Provides access to appearance settings used to customize s’ captions. + + An AppearanceObject that contains appearance settings used to customize s’ captions. + + + + Provides access to appearance settings applied to all tile items within the current . + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings used to paint the current caption. + + An AppearanceObject that contains appearance settings used to paint the current caption. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the background image for this . + + An Image displayed as the ‘s background. + + + + Occurs before a layout is restored from storage (a stream, xml file or the system registry). + + + + + Locks the object by preventing visual updates of the object and its elements until the EndUpdate method is called. + + + + + Gets or sets the style of the current ‘s border. + + A enumerator value that specifies the style applied to the tile control’s border. + + + + Returns information on the tile control elements located at the specified point. + + A structure which specifies the test point coordinates relative to the ‘s top-left corner. + A DevExpress.XtraEditors.TileControlHitInfo object which contains information about the grid elements located at the test point. + + + + Gets or sets the maximum number of medium-sized tiles that can be placed simultaneously in a single row within a vertically oriented . + + An Int32 value that is the maximum number of medium-sized tiles that can be placed simultaneously in a single row within a vertically oriented . + + + + Fires when a context button is clicked. + + + + + Allows you to customize context buttons for individual tiles. + + + + + Provides access to the settings applied to the context buttons displayed in the tiles, and panels containing these buttons. + + A ContextItemCollectionOptions object that comprises settings applied to the context buttons displayed in the tiles, and panels containing these buttons. + + + + Provides access to the collection of context buttons displayed in the tiles. + + A ContextItemCollection object that represents the collection of context buttons displayed in the tiles. + + + + Allows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for and objects. + + + + + Returns the default tile padding. + + The 12, 8, 12, 8 padding structure. + + + + Gets or sets the horizontal and vertical distance in pixels that an end-user must drag a before the drag operation starts. + + A Size structure that specifies the horizontal and vertical distance in pixels that an end-user must drag a before the drag operation starts. + + + + Gets or sets whether the TileControl.ItemDoubleClick event is raised. + + true if the TileControl.ItemDoubleClick event is raised; otherwise, false. + + + + Fires after the dragged tile item is released. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets font options for all s within the current . + This property is now obsolete. Use the TileControl.AppearanceItem property instead. + + A Font object that specifies font options for all tiles within the current . + + + + Gets or sets a color used to paint a s’ text content. This property is now obsolete. Use the TileControl.AppearanceItem property instead. + + A Color object used to paint a s’ text content. + + + + Gets all currently checked tiles that belong to this . + + A List structure that contains all currently checked tiles that belong to this . + + + + Returns the exact size of the target in pixels. + + A whose size is to be obtained. + A Size structure that is the size of the target tile. + + + + Returns the exact size of the target tile style in pixels. + + A enumerator value whose exact size is to be obtained. + A Size structure that is the size of the target tile style. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns a group with the specified name (TileGroup.Name). + + A string that specifies the name of the group to be located. + A with the specified name. null if no matching group is found. + + + + Returns a group with the specified caption (TileGroup.Text). + + A string that specifies the caption of the group to be located. + A with the specified caption. null if no matching group is found. + + + + Provides access to a collection of s used by the current . + + A TileGroupCollection object that stores s used by the current . + + + + Gets the object that controls drag-and-drop and mouse operations on the . + + A TileControlHandler object that controls drag-and-drop and mouse operations on the . + + + + Gets or sets the horizontal alignment of ‘s groups. + + A enumerator value that specifies the horizontal alignment of ‘s groups. + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + Gets or sets a collection of images to be displayed in s. + + An Object that stores a collection of s glyphs. + + + + Gets or sets a space that visually detaches neighboring s. + + An Int32 value specifying a space that visually detaches neighboring s. + + + + Gets or sets a space that visually detaches neighboring s. + + An Int32 value specifying a space that visually detaches neighboring s. + + + + Gets if the animation is currently paused. + + true if the animation is currently paused; otherwise, false. + + + + Gets if the current tile control is locked by the TileControl.BeginUpdate method call. + + true if the current tile control is locked by the TileControl.BeginUpdate method call; otherwise, false. + + + + Gets a value indicating whether the ‘s elements are aligned to support locales using right-to-left fonts. + + true if the ‘s elements are aligned to support locales using right-to-left fonts; otherwise, false. + + + + Provides access to appearance settings applied to all tile items when they are in their normal state. This property is obsolete. Use the TileControl.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings applied to all tile items when they are hovered over. This property is obsolete. Use the TileControl.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings applied to all tile items when they are selected. This property is obsolete. Use the TileControl.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Gets or sets the background image position for all s within the current . + + A enumerator value that specifies the background image position for all s within the current . + + + + Gets or sets the background images stretch mode common to s within the current . + + A TileItemImageScaleMode enumerator value that specifies the background images stretch mode for all s within the current . + + + + Gets or sets whether borders of all tile items are visible. + + A value that specifies whether tile item borders are visible. + + + + Fires when a ‘s check state is changed. + + + + + Gets or sets the way s within the current can be checked by an end-user. + + A enumerator value specifying the way s within the current can be checked by an end-user. + + + + Fires when a user clicks a tile. + + + + + Gets or sets the frame animation effect applied to all within the current . + + A TileItemContentAnimationType enumerator value specifying the frame animation effect applied to all within the current . + + + + Occurs when an end-user double-clicks a within the current . + + + + + Occurs after a tile that was dragged at runtime lands on its final position. + + + + + Gets or sets the way s’ glyphs are aligned within parent items. + + A TileItemContentAlignment enumerator value that specifies the way s’ glyphs are aligned within parent items. + + + + Gets or sets the way s’ glyphs are stretched within parent items. + + A TileItemImageScaleMode enumerator value that specifies the way s’ glyphs are stretched within parent items. + + + + Gets or sets the common padding for all s within the current . + + A System.Windows.Forms.Padding structure that specifies the common padding for all s within the current . + + + + Fires when a user presses a tile. + + + + + Gets or sets the dimension of a medium . + + The dimension of a medium , in pixels. + + + + Gets or sets common settings for all s within the current terms to display their text content. + + A TileItemContentShowMode enumerator value that indicates how s’ text content is displayed. + + + + Gets or sets whether this operates in regular or adaptive layout mode. + + A TileControlLayoutMode enumerator value that specifies whether this operates in regular or adaptive layout mode. + + + + Occurs after a layout whose version doesn’t match the current layout version has been loaded from a stream, xml file or system registry. + + + + + Provides access to the ‘s look and feel settings. + + A object that specifies look and feel settings for the current . + + + + Gets or sets the maximum s ID. + + An Int32 value that is the maximum s ID. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Updates the Tile Control. + + + + + Provides access to settings that are in use when this is in Adaptive Layout Mode. + + A DevExpress.XtraEditors.TileControlAdaptiveLayoutOptions object that stores settings that are in use when this is in Adaptive Layout Mode. + + + + Provides access to advanced layout TileControl settings. + + A DevExpress.XtraEditors.TileControlOptionsLayout object that stores advanced layout TileControl settings. + + + + Gets or sets the tile arrangement algorithm. + + The value specifying the tile arrangement algorithm. + + + + A DirectX-compatible method that replaces the standard Control.Paint method. + + + + + Gets or sets the current ‘s offset in pixels. + + An Integer value specifying the current ‘s offset in pixels. + + + + Loads the layout stored in the specific registry key. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A String value specifying the registry key which contains the layout to be loaded. If the specified key doesn’t exist, an exception is raised. + + + + Loads the layout stored in the specific stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A Stream object which contains the layout to be loaded. If the specified stream doesn’t exist, an exception is raised. + + + + Loads the layout stored in the specific XML file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A String value specifying the path to the XML file which contains the layout to be loaded. If the specified file doesn’t exist, an exception is raised. + + + + Resumes all animation effects. + + + + + Fires after any within the current was clicked with the right mouse button. + + + + + Gets or sets the maximum number of items rows within the current . + + An Integer value specifying the maximum number of items rows within the current . + + + + Saves the current layout to a registry. + + A String value specifying the registry key in which the layout should be stored. If an empty string is specified, an exception is raised. + true if saving was successful; otherwise, false. + + + + Saves the current layout to a stream. + + A Stream object in which the layout should be stored. + + + + Saves the current layout to an XML file. + + A String value specifying the path to the file in which the layout should be stored. If an empty string is specified, an exception is raised. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the time required to show/hide a ‘s scroll buttons when they are hovered over/not hovered with the mouse. + + An Int32 value, specifying the tile control scroll buttons’ fade time (in milliseconds). + + + + Gets or sets which visual elements will be used when a ‘s workspace is being scrolled. + + A enumerator value specifying the scrolling elements used. + + + + Gets or sets the currently selected within a . + + A TileItem object that is currently selected within a . + + + + Fires when a tile item selection occurs for the first time or item selection jumps from one to another. + + + + + Gets or sets the s’ borders color when navigating through tiles using keyboard arrows at runtime. + + A Color object used to paint s’ borders when navigating through tiles using keyboard arrows at runtime. + + + + Gets or sets whether captions are displayed for the current . + + true if captions are displayed for the current ; otherwise, false. + + + + Gets or sets whether the current ‘s caption is displayed. + + true if the current ‘s caption is displayed; otherwise, false. + + + + Gets or sets whether tooltips are shown for tiles. + + true if tooltips are shown; otherwise, false. + + + + Fires after an end-user starts dragging a tile item. + + + + + Pauses all s animation effects until resumed. + + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of tooltips displayed by tiles of the . + + A object which controls the appearance and behavior of tooltips displayed by tiles of the . + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for this Tile Control. + + A DefaultBoolean enumerator value that specifies whether or not this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + Gets or sets the vertical alignment of ‘s groups. + + A enumerator value that specifies the vertical alignment of ‘s groups. + + + + Returns detailed info about this . + + A TileControlViewInfo object that contains detailed info about this . + + + + Exposes members that specify how a tile item glyph is arranged relative to text content. + + + + + Aligns text according to the TileItem.ImageAlignment and places the icon below it. + + + + + Acts as the TileControlImageToTextAlignment.None value disabling an image-to-text grouping. + + + + + Aligns text according to the TileItem.ImageAlignment and places the icon to the left. + + + + + Disables image-to-text grouping. + + + + + Aligns text according to the TileItem.ImageAlignment and places the icon to the right. + + + + + Aligns text according to the TileItem.ImageAlignment and places the icon above it. + + + + + Exposes members that specify a ‘s scroll mode. + + + + + Default scrolling mode. For the , the Default value is equivalent to None, while the interprets the Default value as ScrollBar. + + + + + Prevents any visual scrolling elements from being displayed. content scrolling is still available via mouse scroll (PC users) or sliding the control (touch-input devices users). + + + + + Sets a to display scroll bars when scrolling is enabled. + + + + + Sets a to display scroll buttons when scrolling is enabled. + + + + + Displays a thin solid scroll bar painted right above the control’s client area. + + + + + Implements the functionality of tile groups. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets the tile control to which the current group belongs. + + An object implementing the ITileControl interface to which the group belongs. + + + + Returns a tile item with the specified name (TileItem.Name). + + A string that specifies the name of the item to be located. + A with the specified name. null if no matching item is found. + + + + Returns a tile item with the specified text (TileItem.Text). + + A string that specifies the text of the item to be located. + A with the specified text. null if no matching item is found. + + + + Returns detailed info about this . + + A TileGroupViewInfo object that contains detailed info about this . + + + + Provides access to a collection of s used by the current . + + A TileItemCollection object that stores s used by the current . + + + + Gets or sets the current ‘s name. + + A String value that specifies the current ‘s name. + + + + Gets or sets the site associated with the current . + + A System.ComponentModel.ISite object associated with the current . + + + + Gets or sets the data associated with a object. + + An Object containing the information associated with a object. + + + + Gets or sets the current ‘s caption. + + A String value that is the current ‘s caption. + + + + Gets or sets whether the current is visible. + + true if the current is visible; otherwise, false. + + + + A collection of objects. + + + + + Initializes a new instance of the with specific settings. + + A TileControl that owns the created. + + + + Adds a new into a . + + A to be added. + An Int32 value indicating the position at which the new element was added. + + + + Gets if the specific presents within the current . + + A TileGroup object to be tested. + true if the specific presents within the current ; otherwise, false. + + + + Gets the position of the specified in the current group collection. + + A whose index is to be obtained. + A zero-based Int32 value that is the index of the in the current group collection. + + + + Adds a new into a and places it at the specific position. + + An Int32 value indicating the position to which the inserted group will be placed. + A TileGroup object to be inserted. + + + + Provides indexed access to individual items in the . + + A zero-based integer specifying the desired group’s position within the . If it’s negative or exceeds the last available index, an exception is raised. + A TileGroup object that is contained within the current . + + + + Provides access to the s in the current collection by their names. + + A String value that is the name of a to be obtained. + A object with the specific name. + + + + Gets the object that owns this group collection. + + An object implementing the ITileControl interface to which the group collection belongs. + + + + Removes the specific from the current . + + A to be removed. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Provides the functionality of tile items. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + Gets or sets whether the Tile Animation is enabled for this . + + true if the Tile Animation is enabled for this ; otherwise, false. + + + + Gets or sets whether glyphs for this should be painted using the item’s foreground color. + + A value that specifies if this item’s glyphs should be painted using the item’s foreground color. + + + + Gets or sets if HTML text formatting is enabled for the current . + + A enumerator value that indicates if HTML text formatting is enabled for the current . The DefaultBoolean.Default value acts the same as the DefaultBoolean.True value. + + + + Gets or sets whether a “press” animation effect on a click is allowed for the . + + true, if a “press” animation effect on a click is allowed for the item, false, if animation is disabled + + + + Provides access to appearance settings applied to the tile item when it is in a normal state. This property is obsolete. Use the TileItem.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings applied to the tile item when it is hovered over. This property is obsolete. Use the TileItem.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings used to paint the current . + + An that contains corresponding appearance settings. + + + + Provides access to appearance settings applied to the tile item when it is selected. This property is obsolete. Use the TileItem.AppearanceItem property instead. + + An that contains corresponding appearance settings. + + + + Gets or sets the current ‘s background image. + + An Image object, set as the current ‘s background. + + + + Gets or sets the current ‘s background image position. + + A enumerator value that specifies the current ‘s background image position. + + + + Gets or sets the appearance ‘s background image. + + A enumerator value that specifies the position of the current ‘s background image. + + + + Uses the command selector to find an appropriate parameterized command in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Binds the specific parameterized command to this . + + An Object that is the command to be bound to this . + A Func delegate that passes the specific Object to the command as a parameter. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this . + + An Expression that selects the appropriate command from the source object. + An Object (typically, a ViewModel) where the commandSelector looks for the required command. + A Func delegate that passes the specific Object to the command as a parameter. + The type of a ViewModel that stores a bindable command. + An IDisposable object. Disposing of this object unbinds the command from this . + + + + Gets or sets whether the current ‘s border is visible. + + A value that specifies whether the TileItem’s border is visible. + + + + Gets or sets if the current is checked. + + true if the current is checked; otherwise, false. + + + + Fires after the current ‘s check state was changed. + + + + + Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. + + The command. + + + + Occurs when the CanExecute(Object) status of the has changed. + + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the parameter that is passed to the command specified by the Command property. + + The parameter. + + + + Occurs after the value of the property has changed. + + + + + Gets or sets the animation effect used to display all s within the current . + + A TileItemContentAnimationType enumerator value specifying what animation effect will be used to display all s within the current . + + + + Gets a tile control to which the current belongs. + + An object implementing the ITileControl interface to which the tile item belongs. + + + + Gets a that is currently displayed within a . + + A TileItemFrame object that is currently displayed within the specified . null if tile item contains no frames. + + + + Gets or sets the currently displayed ‘s index. + + An Int32 value that indicates the currently displayed ‘s index. + + + + Provides access to a collection of s used by the current . + + A TileItemElementCollection object that contains the s used by the current . + + + + Gets or sets whether the item is enabled. + + true if the item is enabled; otherwise, false. + + + + Gets or sets whether the TileItem.ItemDoubleClick event for this is raised. + + A DefaultBoolean enumerator value that specifies whether the TileItem.ItemDoubleClick event for this is raised. + + + + Gets or sets a period of time that elapses before one is changed to another. + + An Int32 value specifying a period of time that elapses before one is changed to another. + + + + Gets a collection of frames used by the current . + + A TileItemFrameCollection object that is a collection of frames used by the current . + + + + Gets a that owns the current . + + A TileGroup that owns the current . + + + + Get or sets the current ‘s ID. + + An Int32 value that is the current ‘s ID. + + + + Gets or sets the current tile item’s icon. + + An Image object that is the current tile item’s icon. + + + + Gets or sets the current ‘s icon position. + + A enumerator value that specifies the current ‘s icon position. + + + + Gets or sets the index of the image within the TileControl.Images collection that should serve as the ‘s glyph. + + An Int32 value indicating an index of the image within the TileControl.Images collection that should serve as the ‘s glyph. + + + + Provides access to properties that allow you to set up raster and vector images for this . + + An DevExpress.Utils.ImageOptions object that provides access to image-related settings. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the way a ‘s glyph is stretched within the item. + + A enumerator value that specifies the way a ‘s glyph is stretched within the item. + + + + Gets or sets a tile item’s TileItem.Text‘ position relative to the item’s icon. + This property is obsolete. Use the TileItemElement.ImageToTextAlignment instead. + + A TileControlImageToTextAlignment that specifies a tile item’s TileItem.Image position relative to the item’s TileItem.Text. + + + + Gets or sets the distance between the tile item’s glyph and text when grouped. This property is now obsolete. Use the TileItemElement.ImageToTextIndent property instead. + + An Int32 value that specifies the distance between the tile item’s glyph and text when grouped. + + + + Obsolete. Please use the TileItem.ItemSize property instead. + + + + + Fires when a user clicks the current tile. + + + + + Occurs when an end-user double-clicks the current . + + + + + Gets the info associated with this . + + A TileItemViewInfo object that contains detailed info about this . + + + + Fires when a user presses the current tile. + + + + + Gets or sets the size of the . + + A TileItemSize enumerator value that specifies the size of the . + + + + Gets or sets the current ‘s name. + + A String value specifying the current ‘s name. + + + + Slides from the currently displayed to the next frame in the TileItem.Frames collection. + + + + + Called each time this is clicked. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Called automatically each time an end-user presses this . + + + + + Called automatically each time an end-user right clicks this . + + + + + Provides access to collections of rows, columns, and spans that specify a layout table where you can arrange tile elements. + + A DevExpress.XtraEditors.TileItemTableLayoutOptions object that specifies options that affect the table layout of tile elements. + + + + Gets or sets the padding for the current . + + A System.Windows.Forms.Padding structure that specifies the padding for the current . + + + + Raises the TileItem.ItemClick event. + + + + + Raises the TileItem.RightItemClick event. + + + + + Removes the object assigned to the current tile item. + + + + + Fires after the current was clicked with the right mouse button. + + + + + Gets or sets the number of rows that occupy the current large or wide . + + An Int32 value specifying the number of rows that occupy the current large or wide . + + + + Forces the current tile item to display a specific . + + A to be displayed. + A Boolean value indicating whether the frame should be displayed using the frame animation. + + + + Gets or sets the site associated with the current . + + A System.ComponentModel.ISite object associated with the current . + + + + Starts the frame animation for this from its first frame. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Stops the Tile Frame Animation for the current . + + + + + Gets or sets a for the current tile item. + + A object associated with the current tile item. + + + + Gets or sets the data associated with a object. + + An Object containing the information associated with a object. + + + + Gets or sets the first text block’s content within the current . + + A String value specifying the first text block’s content within the current . + + + + Gets or sets the second text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the second text block’s content within the current . + + + + Gets or sets the second text block’s alignment for the current . + This property is obsolete. Use the TileItemElement.TextAlignment instead. + + A enumerator value specifying corresponding alignment settings. + + + + Gets or sets the third text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the third text block’s content within the current . + + + + Gets or sets the third text block’s alignment for the current . + This property is obsolete. Use the TileItemElement.TextAlignment instead. + + A enumerator value specifying corresponding alignment settings. + + + + Gets or sets the fourth text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the fourth text block’s content within the current . + + + + Gets or sets the fourth text block’s alignment for the current . + This property is obsolete. Use the TileItemElement.TextAlignment instead. + + A enumerator value specifying corresponding alignment settings. + + + + Gets or sets the first text block’s alignment for the current . + This property is obsolete. Use the TileItemElement.TextAlignment instead. + + A enumerator value specifying corresponding alignment settings. + + + + Gets or sets the specifics that determine how the current ‘s text content will be displayed. + + A TileItemContentShowMode enumerator value that indicates how the current ‘s text content is displayed. + + + + Gets or sets whether the item is visible. + + true if the item is visible; otherwise, false. + + + + Exposes the appearance settings used to paint items in the and in different visual states. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with default settings. + + A DevExpress.Utils.AppearanceDefault object containing the default appearance settings. + + + + Initializes a new instance of the class with the specified appearance settings. + + An whose settings will be copied to the created object. + + + + Initializes a new instance of the class. + + An object that implements the DevExpress.Utils.IAppearanceOwner interface and will own the created appearance object. + + + + Applies a DevExpress.Utils.AppearanceDefault object for the desired visual state to the current tile or element. + + A DevExpress.Utils.AppearanceDefault object that should be applied for the desired visual state to the current tile or element. + + + + Applies appearance settings used by the specific tile or tile element for the desired visual state to the current tile or element. + + An used by the specific tile or element that should be applied to the current tile or tile element. + + + + Applies appearance settings used by the specific tile or tile element for all visual states to the current tile or element. + + A object used by the specific tile or element that should be applied to the current tile or tile element. + + + + Releases all resources used by a object of the specific . + + + + + Returns the appearance object contained within the collection by its name. + + A String value that specifies the name of the appearance object. + The object with the specified name. + + + + Specifies appearance settings used to paint a when it is hovered. + + An object containing appearance settings used to paint a tile item when it is hovered. + + + + Specifies appearance settings used to paint a in its regular visual state. + + An object containing appearance settings used to paint a tile item in its regular visual state. + + + + Specifies appearance settings used to paint a when an end-user clicks this item and does not release it. + + An AppearanceObject that stores appearance settings applied to pressed TileItems. + + + + Specifies appearance settings used to paint a when it is selected. + + An object containing appearance settings used to paint a tile item when it is selected. + + + + Returns the textual representation of the . + + A value, which is the textual representation of the . + + + + Exposes members that specify check options of tile items. + + + + + Allows an end-user to check multiple tile items in a single . + + + + + Disables checking tile items within a . + + + + + Allows an end-user to check only one tile item within a at a time. + + + + + A method for handling events that take a object as a parameter. + + The event source that identifies the TileItem that fires the event. + A object that contains data for the event. + + + + A collection with objects. + + + + + Initializes a new instance of the with specific settings. + + A object that owns the item collection created. + + + + Adds the specified item to the current collection. + + An ITileItem object to be added to the collection. + A zero-based index of the item in the collection. + + + + Gets if the specific presents within the current . + + A TileItem object to be tested. + true if the specific presents within the current ; otherwise, false. + + + + Disposes of the current collection. + + + + + Returns an enumerator that iterates through the collection. + + An IEnumerator object that can be used to iterate through the collection. + + + + Gets the position of the specified in the current item collection. + + A whose index is to be obtained. + A zero-based Int32 value that is the index of the in the current item collection. + + + + Inserts new into the current and places it at a specific position. + + An Int32 value indicating the position at which the new item should be placed. + A to be added. + + + + Provides indexed access to individual items in the . + + A zero-based integer specifying the desired item’s position within the . If it’s negative or exceeds the last available index, an exception is raised. + A TileItem object that is contained within the current . + + + + Provides access to the s in the current collection by their names. + + A String value that is the name of a to be obtained. + A object with the specific name. + + + + Gets a that owns the current . + + A TileGroup object that owns the current . + + + + Removes the specified from the current . + + A to be deleted. + + + + Exposes members to specify tile content alignment. + + + + + Content appears vertically aligned at the bottom, and horizontally aligned at the center. + + + + + Content appears vertically aligned at the bottom, and horizontally aligned on the left. + + + + + Content appears vertically aligned at the bottom, and horizontally aligned on the right. + + + + + Default content alignment. + + + + + Indicates that manual text alignment, based on the TileItemElement.TextLocation coordinates, should be used. + + + + + Content is horizontally and vertically aligned at the center. + + + + + Content appears vertically aligned at the center, and horizontally aligned on the left. + + + + + Content appears vertically aligned at the center, and horizontally aligned on the right. + + + + + Content appears vertically aligned on the top, and horizontally aligned at the center. + + + + + Content appears vertically aligned on the top, and horizontally aligned on the left. + + + + + Content appears vertically aligned on the top, and horizontally aligned on the right. + + + + + Supplies data for the TileControl.StartItemDragging and TileControl.EndItemDragging events. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets a tile item that fired an event which takes the object as a parameter. + + A object that fired an event which takes the object as a parameter. + + + + Gets the to which a being dragged is about to be placed. + + A TileGroup in which the current Tile is about to be placed. + + + + A method for handling events that take a object as a parameter. + + The event source that identifies the TileItem that fires the event. + A object that contains data for the event. + + + + Provides the base class for creating and using tile item elements. + + + + + Initializes a new instance of the class with default settings. + + + + + Returns the actual image from the object + + Actual image from the object. + + + + Gets or sets the side of the anchor element at which this should appear. + + An AnchorAlignment enumerator value that specifies the side of the anchor element at which this should appear. + + + + Gets or sets an AnchorElement, relative to which this is aligned. + + An AnchorElement, relative to which this is aligned. + + + + Gets or sets the index of an AnchorElement within the same TileItem.Elements collection as the TargetElement. + + An Int32 value that is the index of an AnchorElement to which this TargetElement is anchored. + + + + Gets or sets the distance between this TargetElement and the AnchorElement to which it is anchored. + + An Int32 value that is the distance between this TargetElement and the AnchorElement to which it is anchored. + + + + Gets or sets the anchor offset for this . + + A Point structure that is the anchor offset for this . + + + + Gets or sets whether the current should be animated during the Tile Animation. + + true if the current should be animated during the Tile Animation; otherwise, false. + + + + Provides access to appearance settings used to paint the current ‘s + + A TileItemAppearances object that stores appearance settings used to paint the current ‘s + + + + Copies the content and content settings of the specific to the current one. + + A whose content and settings should be copied to the current element. + + + + Copies the specific content and content settings of the target to the current one. + + A whose content and settings should be copied to the current element. + true if text content should be copied; otherwise, false. + true if a glyph should be copied; otherwise, false. + + + + Returns a copy of this element. + + A object that is this element’s copy. + + + + Gets a tile element collection to which the current belongs. + + A TileItemElementCollection that owns the current . + + + + Gets or sets the index of the column in the layout table where the current tile element should be placed. + + The zero-based index of the table column that the element should appear within. + + + + Gets or sets this ‘s height. + + An Int32 value that is this ‘s height. + + + + Gets or sets a glyph for the current . + + An Image object that is the current ‘s glyph. + + + + Gets or sets the glyph position for the current . + + A TileItemContentAlignment enumerator value that specifies the glyph position for the current . + + + + Gets or sets whether this should draw a border around its image. + + A DevExpress.XtraEditors.TileItemElementImageBorderMode enumerator value that specifies whether this should draw a border around its image. + + + + Gets or sets the color of a border drawn around this ‘s image. + + The Color of the border drawn around this ‘s image. + + + + Gets or sets an index of the image used as the current ‘s glyph. + + An Int32 value indicating the index of the image used as the current ‘s glyph. + + + + Gets or sets the ‘s graphic content’s position. + + A Point structure that is the glyph’s position. + + + + Provides access to properties that allow you to set up raster and vector images for this . + + A DevExpress.XtraEditors.TileItemElementImageOptions object that provides access to image-related settings. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the way a glyph is stretched within the current . + + A enumerator value that specifies the way a glyph is stretched within the current . + + + + Gets or sets the image size for this . + + A Size structure that is the image size for this . + + + + Gets or sets an ‘s text position relative to the element’s icon. + + A TileControlImageToTextAlignment that specifies a tile item element’s TileItemElement.Image position relative to the item element’s TileItemElement.Text. + + + + Gets or sets the distance between a tile item element’s glyph and text when grouped. + + An Int32 value that specifies the distance between tile item’s glyph and text when grouped. + + + + Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current element. + A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size). + + A DevExpress.Utils.DxImageUri object that specifies the uniform resource identifier of the image to be displayed in the current element. + + + + Gets or sets the maximum width this ‘s text can occupy. + + An Int32 value that is the maximum width this ‘s text can occupy. + + + + Gets or sets the index of the row in the layout table where the current tile element should be placed. + + The zero-based index of the table row that the element should appear within. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether this should be stretched across the entire tile. + + true if this should be stretched across the entire tile; otherwise, false. + + + + Gets or sets whether this should be vertically stretched across the entire tile. + + true if this should be vertically stretched across the entire tile; otherwise, false. + + + + Gets or sets a text content for the current . + + A String value that is the current ‘s text content. + + + + Gets or sets the alignment of the ‘s text content. + + A TileItemContentAlignment enumerator value specifying the alignment of the ‘s text content. + + + + Gets or sets the ‘s text content’s position. + + A Point structure that is the text content’s position. + + + + Returns the text content of the current . + + A String value that is the current ‘s text content. + + + + Gets or sets whether the current ‘s image should be animated during the Tile Animation. + + true if the current ‘s image should be animated during the Tile Animation; otherwise, false. + + + + Gets or sets whether the current ‘s caption should be animated during the Tile Animation. + + true if the current ‘s caption should be animated during the Tile Animation; otherwise, false. + + + + Gets or sets this ‘s width. + + An Int32 value that is this ‘s width. + + + + Gets or sets the Z-order of the current element. + + The Z-order of the current element. + + + + A collection with objects. + + + + + Initializes a new instance of the class. + + An object that implements the INotifyElementPropertiesChanged interface and will own the created collection. + + + + Adds a specific to the current . + + A TileItemElement object to be added to the current . + An Int32 value that is the index of the added . Returns -1 if no element has been added. + + + + Copies the specific element collection to the current . + + A that should be copied to the current . + + + + Locks the , preventing change notifications (and visual updates) from being raised by the object until the EndUpdate or CancelUpdate method is called. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Determines whether this contains the target element. + + A to be checked. + true if this contains the target element; otherwise, false. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets a position of the target within the current . + + A TileItemElement whose index is to be obtained. + An Int32 value that is the position of the target within the current . + + + + Adds a specific to the current and places it at the predefined position. + + An Int32 value that is the position inside the parent a newly added will occupy. + A TileItemElement object to be added to the current . + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets if this is currently locked by the TileItemElementCollection.BeginUpdate method call. + + true if a tile control is currently locked by the TileItemElementCollection.BeginUpdate method call; otherwise, false. + + + + Returns a child object that occupies the target within the current . + + An Int32 value that is the position of the element to be obtained within the current . + A TileItemElement object that occupies the target position within the current . + + + + Gets an object that implements the INotifyElementPropertiesChanged interface and owns the current . + + An INotifyElementPropertiesChanged object that owns the current tile elements collection. + + + + Deletes a specific from the current . + + A TileItemElement to be removed. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Contains data for events that occur for s. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets a that caused firing a related event. + + A that caused firing a related event. + + + + Implements the functionality of tile frames. + + + + + Initializes a new instance of the class with the default settings. + + + + + Gets or sets if the current frame’s background should be animated when the frame is displayed. + + true if the current frame’s background should be animated when the frame is displayed; otherwise, false. + + + + Gets or sets if the current frame’s glyphs should be animated when the frame is displayed. + + true if the current frame’s glyphs should be animated when the frame is displayed; otherwise, false. + + + + Gets or sets if the current frame’s text content should be animated when the frame is displayed. + + true if the current frame’s text content should be animated when the frame is displayed; otherwise, false. + + + + Gets or sets the animation effect used to display the current . + + A TileItemContentAnimationType enumerator value specifying what animation effect will be used to display the current . + + + + Provides access to appearance settings for this . + + An AppearanceObject that stores appearance settings for this . + + + + Gets or sets the current ‘s background image. + + An Image object, set as the current ‘s background. + + + + Provides access to a collection of s used by the current . + + A TileItemElementCollection object that contains the s used by the current . + + + + Gets or sets the current tile item frame’s icon. + + An Image object that is the current tile item frame’s icon. + + + + Gets or sets a period of time that will elapse before the current is changed to the next one. + + An Int32 value specifying a period of time that will elapse before the current is changed to the next one. + + + + Gets or sets the data associated with a object. + + An Object containing the information associated with a object. + + + + Gets or sets the first text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the first text block’s content within the current . + + + + Gets or sets the second text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the second text block’s content within the current . + + + + Gets or sets the third block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the third text block’s content within the current . + + + + Gets or sets the fourth text block’s content within the current . + This property is now obsolete. Use the TileItemElement.Text instead. + + A String value specifying the fourth text block’s content within the current . + + + + Gets or sets if the current should display its own TileItemFrame.BackgroundImage. + + true if the current should display its own TileItemFrame.BackgroundImage; false to display the previous frame’s image. + + + + Gets or sets if the current should display its own glyphs. + + true if the current should display its own glyphs; false to display the previous frame’s glyphs. + + + + Gets or sets if the current should display its own text content. + + true if the current should display its own text content; false to display the previous frame’s context. + + + + A collection of objects. + + + + + Initializes a new instance of the class with the specified owner. + + An object that is the owner of the created collection. + + + + Adds a new into a . + + A to be added. + An Int32 value indicating the position into which the new frame was added. + + + + Clones all settings from the target to this . + + A target object whose settings are to be copied to this . + + + + Gets if the specific presents within the current . + + A TileItemFrame object to be tested. + true if the specific presents within the current ; otherwise, false. + + + + Returns the position of the specific within the current . + + A TileItemFrame object whose position within the current collection is to be obtained. + A zero-based Int32 value specifying the desired frame’s position within the collection. Returns -1 if the frame doesn’t belong to the current collection. + + + + Adds the specific into the current and places it at the desired position. + + An Integer value indicating the newly added ‘s position within the . + A TileItem to be inserted. + + + + Provides indexed access to individual items in the . + + A zero-based integer specifying the desired frame’s position within the . If it’s negative or exceeds the last available index, an exception is raised. + A TileItemFrame object that is contained within the current . + + + + Gets the collection’s owner. + + A ITileItem object that is the collection’s owner. + + + + Deletes a specific from the current . + + A TileItemFrame to be deleted. + + + + Exposes members that specify a glyph’s stretch mode. + + + + + Acts as the TileItemImageScaleMode.NoScale value. + + + + + An image is displayed in its original size and arranged according to the TileItem.ImageAlignment property. + + + + + An image is displayed as is if its actual size is smaller than the size of the container. If the image size is larger than the container’s size, the image is shrunk proportionally to fit the container’s bounds. + + + + + A glyph is stretched in order to fit within the area of a tile item. + + + + + A glyph is stretched horizontally. Its height remains unchanged. + + + + + A glyph is stretched vertically. Its width remains unchanged. + + + + + Zooms an image proportionally so that it’s displayed within the client area in its entirety. + + + + + Zooms an image proportionally, allowing its smaller side (width or height) to be displayed in its entirety. The image is centered, so the larger side (height or width) will not be displayed in its entirety. + + + + + Contains members that label different Tile sizes. + + + + + The default Tile size (equal to the TileItemSize.Wide size). + + + + + A rectangular tile whose side dimensions are twice as large as the TileControl.ItemSize property value. + + + + + A square Tile with its dimensions equal to the TileControl.ItemSize property value. + + + + + A rectangular Tile with its side dimensions equal to half of the TileControl.ItemSize property value. + + + + + A rectangular Tile twice as long as a TileItemSize.Medium Tile. + + + + + An editor that allows end users to display and edit time. + + + + + Creates a new object. + + + + + Closes the editor’s popup window discarding the changes made. + + + + + Occurs when the control’s pop-up window is completely closed and allows you to specify exactly how it was closed. + + + + + Closes the popup window accepting the changes made. + + + + + Allows you to accept or discard the modified control’s value after the pop-up window is closed. + + + + + Gets the editor’s class name. + + The string value identifying the editor’s class name. + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.TouchPopupTimeEditForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Occurs after the control’s pop-up window is completely displayed. + + + + + Gets an object containing properties, methods and events specific to the time editor. + + A object containing time editor settings. + + + + Occurs when the current attempts to close its pop-up window. + + + + + Occurs when the control attempts to open its pop-up window. + + + + + This method is not supported for controls. + + + + + Displays the ‘s pop-up window. + + + + + Gets the text string representing the edited time value. + + A string value representing the editor’s value. + + + + Gets or sets the currently edited time value. + + A object representing the edited time value. + + + + The ‘s client that renders a lightweight chart with a time-span horizontal axis. + + + + + Creates a new object. + + + + + Provides access to the grid options of the time-span chart range control client. + + A object that contains grid options for the range control’s time-span chart client. + + + + Provides access to the range settings of the time-span chart range control client. + + A object that contains settings to customize the range of the time-span chart range control client. + + + + Contains specific settings which define the representation of grid lines and labels in the time-span chart range control client. + + + + + Creates a new object. + + + + + Gets or sets the time-span measurement unit to which the chart’s gridlines and labels should be aligned. + + A enumeration value that represents the measurement unit to which the chart’s gridlines and labels should be aligned. + + + + Specifies the measurement unit to which selection thumbs of the range control are snapped. + + A enumeration value that represents the alignment interval of selection thumbs. + + + + Contains the common settings that define the range displayed by a time-span chart client of the range control. + + + + + Creates a new object. + + + + + Gets or sets the end bound of a time-span chart client range. + + A time-span value that is the range end bound. + + + + Gets or sets the start bound of a time-span chart client range. + + A value that is the range start bound. + + + + The editor to display and edit time intervals. + + + + + Initializes a new instance of the class. + + + + + Gets the editor’s class name. + + A string value representing the editor’s class name. + + + + Gets or sets the editor’s value (time span). + + An object representing the editor’s value (time span). + + + + Returns the control’s popup window. + + A DevExpress.XtraEditors.Popup.TimeSpanEditDropDownForm object that represents the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Gets an object which contains properties, methods and events specific to the time span editor. + + A object that comprises the settings for the time span editor. + + + + Gets the DateTime representation of the time interval. + + The DateTime representation of the time interval. + + + + Gets or sets the editor’s value (time span). + + A object representing the editor’s value (time span). + + + + A check editor that uses a movable bar to edit Boolean values. + + + + + Initializes a new instance of the class. + + + + + Gets the editor’s class name. + + A System.String object identifying the class name of the current editor. + + + + Gets or sets the editor’s edit value, which specifies the editor’s check state. + + The editor’s edit value. + + + + Gets or sets the control’s check state. + + true if the control is checked; otherwise, false. + + + + Fires when the ToggleSwitch.IsOn property value changes. + + + + + Gets an object containing properties, methods and events specific to the control. + + A object instance containing settings for the control. + + + + This property is not supported by the class. + + + + + Inverts the state of the control. + + + + + Fires when the control’s state is changed. + + + + + The text editor that applies custom validation to the entered text and transforms text blocks which passed this validation to tokens. See Token Edit Control. + + + + + Initializes a new instance of the class with the default settings. + + + + + Focuses this ‘s text box. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.BeforePopup + + + + + Occurs before the peek panel assigned to this is displayed. + + + + + Gets which control’s element is located at the specific position. + + A Point structure that specifies the target position. + An DevExpress.XtraEditors.ViewInfo.TokenEditHitInfo enumerator value that specifies which control’s element is located at the specific position. + + + + Gets which token element is located at the specific position. + + An Int32 value that is the X-axis coordinate of the target location. + An Int32 value that is the Y-axis coordinate of the target location. + An DevExpress.XtraEditors.ViewInfo.TokenEditHitInfo enumerator value that specifies which control’s element is located at the specific position. + + + + Gets the currently checked token within this . + + A TokenEditToken that is the currently checked token within this . + + + + Returns the object that contains all currently checked tokens within this . + + A DevExpress.XtraEditors.TokenEditCheckedItemCollection object that contains all currently checked tokens within this TokenEdit. + + + + Checks the token with the specified value in your TokenEdit control. + + An Object that is the value of the token that will be checked. + + + + Returns this . + + A TokenEdit object that is this itself. + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.Closed + + + + + Closes the drop-down window. + + + + + Forces the ‘s pop-up to close in a specific mode. + + A PopupCloseMode enumerator value that specifies the mode in which the ‘s pop-up is closed. + + + + Moves focus away from this ‘s text box and optionally removes the last entered text. + + true if the last entered text should be removed; otherwise, false. + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.CloseUp + + + + + Allows you to re-draw the default token glyph. + + + + + Allows you to re-paint the token text area. + + + + + Gets whether the token editor or its pop-up form has focus. + + true if the token editor or its pop-up form has focus; otherwise, false. + + + + Returns the textual representation of the class. + + Return value: TokenEdit. + + + + Returns the text currently displayed in the . + + A String value that is the currently displayed in the text. + + + + Explicitly initializes this Token Edit Control‘s drop-down menu. + + + + + Returns the control’s popup window. + + An object that is the control’s popup window. null (Nothing in VB) if the popup window has not been opened yet. + + + + Returns a TokenEditSelectedItemCollection object that contains all tokens currently visible within the editor. + + A DevExpress.XtraEditors.TokenEditSelectedItemCollection object that contains all tokens currently visible within the editor. + + + + Returns the object that contains the internal information used to render this . + + A DevExpress.XtraEditors.ViewInfo.TokenEditViewInfo object that contains the internal information used to render the editor. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Checks whether there are any tokens currently displayed within the ‘s edit box. + + true if there are any tokens currently displayed within the ‘s edit box; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Checks whether or not this is currently focused. + + true if this is currently focused; otherwise, false. + + + + Gets whether the editor’s popup is currently open. + + true if the editor’s popup is currently open; otherwise, false. + + + + Gets or sets whether the ‘s text box currently has focus. + + true if the ‘s text box currently has focus; otherwise, false. + + + + Gets the text box that provides text editing functionality. + + A DevExpress.XtraEditors.TokenEditMaskBox object that is the editor’s text box. + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.Popup + + + + + When the RepositoryItemTokenEdit.DropDownShowMode property is set to Outlook, the drop-down menu width is calculated according to the widest token available. The PopupAutoWidthCalculationLimit property allows the Token Edit to check only first N tokens when it calculates the required menu width. This limitation speeds up the calculation process and improves the control performance. + + The number of tokens whose widths the editor should check before it chooses the required drop-down menu width. + + + + Provides access to an object that stores the main settings. + + A object that stores the main settings. + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.QueryCloseUp + + + + + DevExpress.XtraEditors.Repository.RepositoryItemTokenEdit.QueryPopUp + + + + + Hides a token with the specified value from the TokenEdit control’s textbox. + + An Object that is the value of the token that will be hidden. + + + + Occurs when a user clicks the Remove button in the TokenEdit drop-down menu. + + + + + Scrolls this up or down to the target token. + + A TokenEditToken to which this should be scrolled. + + + + Gets the collection that contains all tokens currently visible within the editor. + + A DevExpress.XtraEditors.TokenEditSelectedItemCollection object that contains all tokens currently visible within the editor. + + + + Occurs whenever the list of currently selected tokens changes. + + + + + Selects an item with specified value. + + An Object that is the value of the token that should be selected. + + + + Displays the drop-down assigned to this . + + + + + Gets or sets whether this can be focused by sequentially pressing the Tab keyboard key. + Always equal to true. + + Always true (this can always be focused using the Tab key). + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Occurs when a token in this changed its checked state. + + + + + Gets or sets the first visible token row within this . + + An Int32 value that is the number of the first visible token row within this . + + + + Unchecks the token with the specified value in your TokenEdit control. + + An Object that is the value of the token that needs to be unchecked. + + + + Validates the text entered in this . + + + + + Allows you to perform the custom validation on text currently entered in this control. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets the hash code (a number) that corresponds to the value of the current object. + + The hash code for the current object. + + + + Returns a string representing the current object. + + A String value that represents the current object. + + + + Enumerates values that specify the type of the value. + + + + + The property returns System.Enum values, which are selected tokens. + + + + + The property returns a ComponentModel.BindingList object that contains selected tokens. + + + + + The property returns a System.String value that contains the selected tokens separated with a comma. + + + + + Displays a scale with tick marks. Users can drag a thumb to change the current value. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the track bar’s size is automatically calculated, based on its look and feel settings. + + true to allow a track bar to automatically calculate its size; otherwise, false. + + + + Fires after the value of the RepositoryItemTrackBar.AutoSize property has been changed. + + + + + Gets or sets the track bar’s background image. + + An that represents the background image. + + + + Fires after the value of the TrackBarControl.BackgroundImage property has been changed. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + An value that specifies the position of an image on the control. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Allows you to provide custom tooltips for the thumb(s). + + + + + Calculates the minumum height of the editor. + + The minimum height of the editor, in pixels. + + + + Occurs when a label within the current needs to be displayed. + + + + + Decreases the value. + + true to decrease the value by ; false to decrease the value by . + + + + Gets the editor’s class name. + + The string that represents the editor’s class name. + + + + Gets or sets the editor’s value. + + An object that represents the editor’s value. + + + + Gets or sets the font used to display the editor’s contents. + + A object that specifies the font used to display the editor’s contents. + + + + Gets the foreground color of the TrackBarControl. + + Always SystemColors.WindowText. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A value. + + + + Gets or sets the Input Method Editor (IME) mode of the control. + + One of the values. + + + + Fires after the value of the TrackBarControl.ImeMode property has been changed. + + + + + Increases the value. + + true to increase the value by ; false to increase the value by . + + + + Gets or sets the inplace type of editor. + + A enumeration member specifying the inplace editor type . + + + + Scrolls the trackbar to the lower end of the range. + + + + + Scrolls the trackbar to the upper end of the range. + + + + + Moves the thumb to the left by the value. + + + + + Moves the thumb to the right by the value. + + + + + Moves the thumb to the left by the value. + + + + + Moves the thumb to the right by the value. + + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A object. + + + + Gets an object which contains properties, methods and events specific to track bars. + + A object that contains track bar settings. + + + + Fires the sequence of the TrackBarControl.CustomLabel events for every tick within a . + + + + + Fires when a user changes the trackbar’s value using the mouse or keyboard. + + + + + Overrides the BaseEdit.Text property. + + A string value that represents the text displayed by the editor. + + + + Fires after the value of the TrackBarControl.Text property has been changed. + + + + + Returns a string that represents the TrackBarControl. + + A string that represents the TrackBarControl. + + + + Gets or sets the editor’s value. + + An integer value that specifies the editor’s value. + + + + Fires after the value of the TrackBarControl.Value property has been changed. + + + + + Contains values that specify which date grouping Views are available in Windows Vista display mode. + + + + + Combines the following views: MonthView, QuarterView, YearView, YearsGroupView and CenturyView. + + + + + A century view: + + + + + + Combines the following views: MonthView, YearView, YearsGroupView and CenturyView. + + + + + A month view: + + + + + + A year view by quarters: + + + + + + A 12-years view: + + + + + + A year view by months: + + + + + + Contains values that specify how a control indicates data operations performed in a background thread. + + + + + The same as the WaitAnimationOptions.Indicator option. + + + + + Background operations are indicated within a dedicated indicator button. + For the , these operations are indicated within the Header Panel Button. + + + + + Background operations are indicated within a special panel displayed above a control. + + + + + Exposes members common to dialogs and message boxes, whose event arguments derive from this class. + + + + + Initializes a new instance of the XtraBaseArgs class with the specified settings. + + A UserLookAndFeel object that should be applied to the owner. + The window that owns this XtraBaseArgs object. + The owner caption. + Buttons displayed by the owner. + The index of the default owner button. The default button is focused when the owner shows on-screen. Additionally, if the AutoClose settings are specified, this button will be considered as clicked when the timer expires. + Specifies whether the owner supports HTML-inspired Text Formatting. + The system sound played when the owner is shown on-screen. + + + + Gets or sets whether the shown object supports HTML-inspired Text Formatting. + + Specifies whether HTML tags are accepted. + + + + Gets or sets whether the or trims the caption to accommodate the contents. + + true, if the control trims the caption to accommodate the contents; false, if the control stretches and attempts to show the entire caption. + + + + Provides access to settings that allow the shown object (XtraMessageBox, XtraInputBox, etc.) to automatically close after a certain delay. + + Provides access to auto-close settings. + + + + Gets or sets the alignment mode for buttons of this dialog or message. + + The button alignment mode. + + + + Gets or sets the padding for buttons of this message or dialog. + + The button padding. + + + + Gets or sets buttons that the shown object (XtraMessageBox, XtraInputBox, etc.) has. + + An array of owner buttons. + + + + Gets or sets the shown object (XtraMessageBox, XtraInputBox, etc.) caption. + + The owner caption. + + + + Gets or sets the distance between the dialog (message box) content and borders. + + The distance between borders and dialog (message box) content. + + + + Gets or sets the index of a button from the Buttons collection that is a default button. A default button is initially focused and is considered clicked when user presses Enter or the auto-close timer expires (see ). + + The index of a default button. + + + + Returns the owner LookAndFeel object. + + The owner LookAndFeel. + + + + Occurs when a user clicks any element within an HTML template. + + + + + Occurs when a mouse button is pressed, and the mouse pointer is over an HTML element. + + + + + Occurs when a mouse pointer moves while over an element of an HTML-CSS template. + + + + + Occurs when a mouse pointer leaves the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse pointer enters the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse button pressed over an element of an HTML-CSS template is released. + + + + + Gets or sets or . can display images from this collection. + + An object that is an image collection. + + + + Returns the HTML-CSS template applied to this message or dialog. + + The custom message or dialog template. + + + + Gets or sets the LookAndFeel object applied to the owner. + + The LookAndFeel object applied to the owner. + + + + Gets or sets the system sound played when the owner appears on-screen. + + The system sound played. + + + + Gets or sets the owner of this XtraBaseArgs object. + + The owner of this XtraBaseArgs object. + + + + Provides access to a Form embedded into a shown object. + + + + + A message box that can display any control (e.g., a UserControl) in its client area. + + + + + Gets or sets whether a dialog is painted using its own look and feel settings, which are specified by the lookAndFeel parameter of specific XtraDialog.Show method overloads. This property is ignored if the lookAndFeel parameter is set to use a skinning paint scheme. + + true, if the dialog is painted using its own look and feel settings; false, if the default look and feel settings are used. + + + + Gets or sets whether the HTML Text Formatting feature is enabled by default for dialog captions. + + true if the HTML text formatting feature is enabled for dialog captions; otherwise, false. + + + + Gets or sets whether the buttons are aligned on the left, right, or in the center. + + A value the specifies whether the buttons are aligned on the left, right, or in the center. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + A control to be displayed in the dialog’s client area. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + An array of values that specify which buttons should be displayed in the dialog. + The zero-based index of the default button. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + An array of values that specify which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object whose properties specify the dialog’s look and feel. + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + One of the values. + + + + Displays an with the specified settings. + + An XtraDialogArgs object that allows you to dynamically customize the displayed dialog. + A enumerator value that specifies what dialog button an end-user has clicked. + + + + Invokes a dialog with the specified settings. + + A control to be displayed in the dialog’s client area. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified control, caption, buttons and default button. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + One of the values. + + + + Invokes a dialog with the specified control, caption and buttons. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values. + + + + Invokes a dialog with the specified control and caption. + + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + One of the values. + + + + Invokes a dialog displaying the specified control in its client area. + + A control to be displayed in the dialog’s client area. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + An array of values that specify which buttons should be displayed in the dialog. + The zero-based index of the default button. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified owner, control, buttons and default button. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + An array of values that specify which buttons should be displayed in the dialog. + The zero-based index of the default button. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified settings. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + A value that specifies whether HTML tags can be used to format the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified owner, control, caption, buttons and default button. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values that specifies the default button for the dialog. + One of the values. + + + + Invokes a dialog with the specified owner, control, caption and buttons. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + A value that specifies which buttons should be displayed in the dialog. + One of the values. + + + + Invokes a dialog with the specified control, caption and owner. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + A string that specifies the dialog’s caption. + One of the values. + + + + Invokes a dialog with the specified owner and control. + + An object that serves as the dialog’s top-level window and owner. + A control to be displayed in the dialog’s client area. + One of the values. + + + + Arguments that should be passed to the method to customize the shown . + + + + + Initializes a new XtraDialogArgs class instance. + + An object that specifies look and feel settings. + An IWin32Window object that provides look and feel settings for the dialog box. + A Control object that specifies the dialog box content. + The text in the title bar. + An array of values that specifies which buttons to display in the input box. + An integer value that specifies the default button’s index in the buttons array. + True to parse HTML tags; False to display the plain text; Default to use the static (Shared in VB) XtraMessageBox.AllowHtmlText property. + A value that specifies the system sound played when the input box is shown. + + + + Initializes a new XtraDialogArgs class instance. + + An IWin32Window object that provides look and feel settings for the dialog box. + A Control object that specifies the dialog box content. + The text in the title bar. + An array of values that specifies which buttons to display in the input box. + An integer value that specifies the default button’s index in the buttons array. + + + + Gets or sets a control that specifies the dialog box content. + + A Control object that specifies the dialog box content. + + + + A skinable dialog with one editor () and OK/Cancel buttons to accept or reject the current value of this editor. + + + + + Gets or sets whether input boxes use the default or custom look and feel settings. + + true if input boxes use the custom look and feel settings; false if the default look and feel settings are used. + + + + Members of this enumeration allow you to specify what buttons an dialog should display. + + + + + The “OK” button for messages. + + + + + The set of “OK” and “Cancel” buttons for messages. + + + + + The set of “Yes” and “No” buttons for messages. + + + + + Gets or sets whether the buttons are aligned on the left, right, or in the center. + + A value the specifies whether the buttons are aligned on the left, right, or in the center. + + + + Displays an input box with the specified settings. + + An object that comprises dialog box settings. + The entered value, or null (Nothing in VB.NET) if nothing was entered. + + + + Displays an with the given parameters. + + The text string displayed above an editor. + The caption of the message window. + The initial editor value. + Specifies editor buttons. + The value entered by a user, or null if no value was entered. + + + + Displays an input box with the specified title, prompt, and default response. + + The text above the editor. + The text in the title bar. + The text that is the editor’s default value. + The entered value, or null if nothing was entered. + + + + Displays an with the given parameters. + + The owner of the displayed Input Box. + The text string displayed above an editor. + The caption of the message window. + The initial editor value. + Specifies editor buttons. + The value entered by a user, or null (Nothing in VB.NET) if no value was entered. + + + + Displays an input box with the specified title, prompt, and default response. + + An IWin32Window object that shares its look-and-feel settings with this Input Box. + The text above the editor. + The text in the title bar. + The text that is the editor’s default value. + The entered value, or null if nothing was entered. + + + + Displays an input box with the specified settings. + + An object that specifies the input box settings. + The returned value’s type. + The value entered by a user, or null (Nothing in VB.NET) if nothing was entered. + + + + Displays an input box with the specified settings. + + The text string displayed above an Input Box editor. + The Input Box window caption. + The initial editor value. + Specifies Input Box buttons. + The type of a value requested from users. + The value entered by a user, or null if nothing was entered. + + + + Displays an input box with the specified title, prompt, and default response. You can also specify the returned value’s type. + + The text above the editor. + The text in the title bar. + The editor’s default value. + The returned value’s type. + The value entered by a user, or null if nothing was entered. + + + + Displays an input box with the specified settings. + + The owner of this Input Box. + The text string displayed above an editor. + The title of this Input Box. + The initial editor value. + Specifies buttons displayed by this Input Box. + The type of a value requested from users. + The value entered by a user, or null if nothing was entered. + + + + Displays an input box with the specified title, prompt, and default response. + + An IWin32Window object that shares its look-and-feel settings with this Input Box. + The text above the editor. + The text in the title bar. + The editor’s default value. + The returned value’s type. + The value returned by a user, or null if nothing was entered. + + + + Arguments that should be passed to the method to customize the shown . + + + + + Initializes a new XtraInputBoxArgs class instance. + + An object that specifies look and feel settings. + An IWin32Window object that provides look and feel settings for the dialog box. + The text above the editor. + The text in the title bar. + The editor’s default value. + An array of values that specify which buttons to display in the input box. + An integer value that specifies the default button’s index in the buttons array. + True to parse HTML tags; False to display the plain text; Default to use the static (Shared in VB) XtraMessageBox.AllowHtmlText property. + A value that specifies the system sound played when the input box is shown. + + + + Initializes a new XtraInputBoxArgs class instance. + + An IWin32Window object that provides look and feel settings for the dialog box. + The text above the editor. + The text in the title bar. + The editor’s default value. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. Use the property instead to choose input box buttons. + + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + + Gets or sets the default response for the dialog box. + + An Object that represent the default response. + + + + Gets or sets a custom editor for the dialog box. + + A object that represents a custom editor for the dialog box. + + + + Gets or sets the text to display in the dialog box. + + A string value that specifies the text to display in the dialog box. + + + + The message box that supports title bar skinning. + + + + + Gets or sets whether the message box is painted using its own look and feel settings. + + true if the message box is painted using its own look and feel settings; false if the default look and feel settings are used. + + + + Gets or sets whether the HTML text formatting feature is enabled by default in message boxes, displayed using the XtraMessageBox.Show method. + + true if the HTML text formatting feature is enabled by default in message boxes; otherwise, false. + + + + Gets or sets whether message box buttons are center, left or right aligned. This is a static (Shared in VB) property. + + A enumeration value, such as Center, Left or Right, that specifies how message box buttons are aligned. The default is Center. + + + + Provides access to custom icons. + + A <,,> object that stores custom icons. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the registry path used to store and property values in the registry. + + The registry path. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + The text to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + The text to display in the message box. + A string value that specifies the caption of the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + The text to display in the message box. + The message box’s caption. + A value that specifies which buttons to display in the message box. + A value that specifies whether HTML tags can be used to format a message box’ text and caption. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + The text to display in the message box. + A string value that specifies the caption of amessage box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, text, caption, buttons, icon and default button. + + A object whose properties specify the look and feel of the message box. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, text, caption, buttons and icon. + + A object whose properties specify the look and feel of the message box. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, text, caption and buttons. + + A object whose properties specify the look and feel of the message box. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, text and caption. + + A object whose properties specify the look and feel of the message box. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings and text. + + A object whose properties specify the look and feel of the message box. + A string value that specifies the text to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + An array of values that specify which buttons to display in the message box. + The displayed in the message box. + The zero-based index of the default button. + One of the values that specifies a system-alert level. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, owner, text, caption, buttons, icon, default button and plays the sound that corresponds to the specified system-alert level. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + An array of values that specify which buttons to display in the message box. + The displayed in the message box. + The zero-based index of the default button. + One of the values that specifies a system-alert level. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + A string value that specifies the text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + A object whose properties specify the look and feel of the message box. + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, text, caption, buttons, icon and default button. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, owner, text, caption, buttons and icon. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, owner, text, caption and buttons. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, owner, text and caption. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + One of the values. + + + + Displays the XtraMessageBox with the specified look and feel settings, owner and text. + + A object whose properties specify the look and feel of the message box. + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + One of the values. + + + + Displays an with the specified settings. + + An XtraMessageBoxArgs object that allows you to dynamically customize the displayed dialog. + A enumerator value that specifies which message box button an end-user has clicked. + + + + Displays the XtraMessageBox with the specified settings. + + The text to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + The text to display in the message box. + A string value that specifies the caption of the message box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + The text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified text, caption, buttons, icon and default button. + + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified text, caption, buttons and icon. + + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified text, caption and buttons. + + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified text and caption. + + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + One of the values. + + + + Displays the XtraMessageBox with the specified text. + + A string value that specifies the text to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as the top-level window and owner of a dialog box. + A string value that specifies the text to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + An array of values that specify which buttons to display in the message box. + The displayed in the message box. + The zero-based index of the default button. + One of the values that specifies a system-alert level. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified owner, text, caption, buttons, icon, default button and plays the sound that corresponds to the specified system-alert level. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + An array of values that specify which buttons to display in the message box. + The displayed in the message box. + The zero-based index of the default button. + One of the values that specifies a system-alert level. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as a dialog box’s top-level window and owner. + The text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified settings. + + An object that serves as the top-level window and owner of a dialog box. + The text to display in the message box. + A string value that specifies the caption of a message box. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + A value that specifies whether HTML tags can be used to format the text and caption of a message box. See XtraMessageBox.AllowHtmlText to learn more. + One of the values. + + + + Displays the XtraMessageBox with the specified owner, text, caption, buttons, icon and default button. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values that specifies the default button for the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified owner, text, caption, buttons and icon. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values that specifies which icon to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified owner, text, caption and buttons. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + A value that specifies which buttons to display in the message box. + One of the values. + + + + Displays the XtraMessageBox with the specified owner, text and caption. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + A string value that specifies the message box’s caption. + One of the values. + + + + Displays the XtraMessageBox with the specified owner and text. + + An object that serves as a dialog box’s top-level window and owner. + A string value that specifies the text to display in the message box. + One of the values. + + + + Gets or sets whether the message box width is restricted based on the available working area, and the text is automatically wrapped. This is a static property. + + true if the message box width is restricted based on the available working area, and the text is automatically wrapped; otherwise, false. The default is false. + + + + Gets or sets whether all XtraMessageBoxes should retrieve element paddings from skins. + + Specifies whether all XtraMessageBoxes should retrieve element paddings from skins. + + + + Arguments that should be passed to the method to customize the shown . + + + + + Initializes a new XtraMessageBoxArgs class instance. + + An object that specifies look and feel settings. + An IWin32Window object that provides look and feel settings for the dialog box. + The text in the message box. + The text in the title bar. + An array of values that specify which buttons to display in the input box. + The icon in the title bar. + An integer value that specifies the default button’s index in the buttons array. + True to parse HTML tags; False to display the plain text; Default to use the static (Shared in VB) XtraMessageBox.AllowHtmlText property. + A value that specifies the system sound played when the input box is shown. + + + + Initializes a new XtraMessageBoxArgs class instance. + + An IWin32Window object that provides look and feel settings for the dialog box. + The text in the message box. + The text in the title bar. + An array of values that specify which buttons to display in the input box. + The icon in the title bar. + An integer value that specifies the default button’s index in the buttons array. + + + + Gets a new instance of the class. + + A new instance of the object. + + + + Occurs when an closes. + + + + + Gets or sets padding for the “Do not show this message again“ checkbox. + + Checkbox padding. + + + + Gets or sets the text displayed next to the “Do not show this message again“ checkbox. + + The text displayed next to the “Do not show this message again“ checkbox. + + + + Gets or sets whether the “Do not show this message again“ checkbox is shown in an . + + true if the “Do not show this message again“ checkbox is shown in an XtraMessageBox; otherwise, false. + + + + Gets or sets whether to use GDI+ to render strings. For internal use. + + true to use GDI+ to render strings; otherwise, false. + + + + For internal use. + + + + + + Fires when a hyperlink is clicked. + + + + + Gets or sets an icon. The icon is displayed in the message body. + + An object that specifies the message box icon. + + + + Gets or sets padding for an icon. + + Message box icon padding. + + + + Occurs before an is created. + + + + + Gets or sets a registry key used to store the and property values in the registry. + + The registry key. + + + + Gets or sets a registry path used to store the and property values in the registry. + + The registry path. + + + + Gets or sets the message box text. + + A String value that specifies the message box text. + + + + Gets or sets text padding within an . + + Text padding. + + + + Gets or sets whether to use GDI+ to render strings. + + true to use GDI+ to render strings; otherwise, false. + + + + Gets or sets whether message boxes that utilize this XtraMessageBoxArgs object should retrieve content paddings from the current DevExpress skin. + + Specifies whether to retrieve message box paddings from skins. The Default value means the behavior is inherited from the global XtraMessageBox.UseSkinPaddings property. + + + + Supplies data for the event. + + + + + Initializes a new instance of the class with specified settings. + + An object that defines the . + + + + Saves and property values to the registry. + + + + + Supplies data for the and events. + + + + + Initializes a new instance of the class with specified settings. + + A that defines an . + + + + Gets or sets the value that corresponds to the button the user chose in an . + + A enum value that is a button the user chose in an XtraMmessageBox. + + + + Gets the current ‘s settings through its object. + + A object that defines the . + + + + Gets or sets whether the user checked the Do not show this message again checkbox and whether to show the again. + + true, if the user did not check the checkbox and the XtraMessageBox is shown again; false, if the user checked the checkbox and suppressed the XtraMessageBox. + + + + Supplies data for the event. + + + + + Initializes a new instance of the class with specified settings. + + An object that defines the . + + + + Restores the and property values from the registry if these values are available. + + + + + Forcibly shows an an end user suppressed. Use this method when an end user checked the “Do not show this message again“ checkbox and closed the message. + + true, to show an with the “Do not show this message again“ checkbox checked; false, to show an with the “Do not show this message again“ checkbox unchecked. + + + + The slider with the ‘+’ and ‘-‘ buttons. + + + + + Initializes a new instance of the class. + + + + + Occurs after the ZoomTrackBar control’s pressed button has been released. + + + + + Occurs immediately after the ZoomTrackBar control’s button has been pressed. + + + + + Calculates the editor’s minimum height. + + The editor’s minimum height, in pixels. + + + + Gets the editor’s class name. + + A object identifying the class name of the current editor. + + + + Gets an object which contains properties, methods and events specific to the control. + + A object that contains a control’s settings. + + + + Contains classes that provide information about the grid control, grid levels and implement the functionality for summaries, styles and style conditions. + + + + + Lists values specifying comparison operators used when applying conditional styles. + + + + + The style is applied to cells (or rows) whose values are between the and property values exclusive. Enable the option to make the condition inclusive. + + + + + The style is applied to cells (or corresponding rows) whose values match the StyleFormatConditionBase.Value1 property value. + + + + + The style is applied to cells (or corresponding rows) if the StyleFormatConditionBase.Expression evaluates to true. + + + + + The style is applied to cells (or corresponding rows) whose values are greater than that specified by the StyleFormatConditionBase.Value1 property. + + + + + The style is applied to cells (or corresponding rows) whose values are greater or equal to the StyleFormatConditionBase.Value1 property value. + + + + + The style is applied to cells (or corresponding rows) whose values are less than that specified by the StyleFormatConditionBase.Value1 property. + + + + + The style is applied to cells (or corresponding rows) whose values are less or equal to the StyleFormatConditionBase.Value1 property value. + + + + + The style is not applied to any cell. + + + + + The style is applied to cells (or rows) whose values are not between the and property values inclusive. Enable the option to make the condition exclusive. + + + + + The style is applied to cells (or corresponding rows) whose values do not match the StyleFormatConditionBase.Value1 property value. + + + + + Contains classes which implement the main functionality of the PivotGridControl. + + + + + Lists values that identify buttons displayed within filter popup toolbars. + + + + + All toolbar buttons. + + + + + + The Incremental Search button that controls whether the incremental searching feature is enabled or not. This feature allows end-users to locate an item in the drop-down by typing the item’s initial characters. + Corresponding property: PivotGridOptionsFilterPopup.AllowIncrementalSearch. + + + + + + The Invert Filter button that inverts the checked state for all filter items. + + + + + + The Multi-Selection button that controls whether end-users are allowed to select only a single item or multiple items. + Corresponding property: PivotGridOptionsFilterPopup.AllowMultiSelect. + + + + + No toolbar buttons are displayed. + + + + + + The Radio Mode button that controls whether end-users are allowed to check only a single item or multiple items. + Corresponding properties: PivotGridOptionsFilterPopup.IsRadioMode, PivotGridFieldOptionsEx.IsFilterRadioMode. + + + + + + The Show New Field Values button controls the visibility of field values that have appeared in the datasource after the field’s filtering was configured. + Corresponding properties: PivotGridFieldBase.ShowNewValues, PivotGridGroup.ShowNewValues. + + + + + + The Show Only Available Items button that controls the visibility of filter items that cannot be displayed because of filtering applied to other fields. + Corresponding property: PivotGridOptionsFilterBase.ShowOnlyAvailableItems. + Note that this option is not available for Group Filters. + + + + + Contains classes that encapsulate splash forms. + + + + + The base class for splash forms displayed using the component. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the color of the glow effect for the current splash form displayed in the active state. + + A Color structure that specifies the color of the glow effect for the current splash form. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Closes the current or after a specified delay. + Allows you to select a form that should be subsequently activated. + + An Int32 value that is the number of milliseconds that elapses before the splash form is closed. + A Form object that should be activated after the splash form is closed. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the color of the glow effect for the current splash form displayed in the inactive state. + + A Color structure that specifies the color of the glow effect for the current splash form. + + + + When overridden, the method allows you to process commands received from a via the SplashScreenManager.SendCommand method. + + An enumeration value that identifies the received command. + The received command’s parameter. + + + + Contains properties controlling the form’s appearance. These settings are in effect when the form is displayed on its own, without using the component. + + A object that contains form appearance settings. + + + + Displays the current form as a non-modal dialog window. + + + + + Displays the current form as a modal dialog box. + + A value that is the return value of the displayed dialog box + + + + Contains classes that support the SplashScreenManager’s infrastructure. + + + + + Contains settings to customize splash screens via the SplashScreenManager.ShowFluentSplashScreen method. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the appearance settings used to paint the text in the left footer region. + + The appearance settings used to paint the text in the left footer region. + + + + Gets or sets the appearance settings used to paint the text in the right footer region. + + The appearance settings used to paint the text in the right footer region. + + + + Gets or sets the appearance settings used to paint the subtitle. + + The appearance settings used to paint the subtitle. + + + + Gets or sets the appearance settings used to paint the title. + + The appearance settings used to paint the title. + + + + Copies settings from the specified object to the current object. + + The object whose settings are copied to the current object. + + + + Disposes of the current object. + + + + + Gets or sets the text displayed in the left footer region. If this parameter is not specified (null), the left footer displays the value of the AssemblyCopyright attribute (see your project’’s AssemblyInfo.cs/AssemblyInfo.vb file). + + The text displayed in the left footer region. + + + + Gets or sets the loading indicator kind. + + The loading indicator kind. + + + + Contains settings to specify and customize a raster or vector logo image. + + An object that provides settings to specify and customize a raster or vector logo image. + + + + Gets or sets the opacity level of the splashscreen’s background. This setting is supported if the application runs under Windows 10 Version 1803 (OS build 17134) or newer. On older Windows versions, the splashscreen fills its background with a non-trasparent color specified by the OpacityColor property. + + The opacity level (between 0 and 255) of the splashscreen’s background. + + + + Gets or sets the background color. If this parameter is set to Color.Empty, the actual background color is Color.Black. + + The background color. + + + + Gets or sets the text displayed in the right footer region. + + The text displayed in the right footer region. If this parameter is not specified (null), the right footer displays the value of the AssemblyFileVersion attribute (see your project’’s AssemblyInfo.cs/AssemblyInfo.vb file). + + + + Gets or sets the subtitle. If this parameter is not specified (null), the subtitle region displays the value of the AssemblyCompany attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + + The subtitle. + + + + Gets or sets the title. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + + The title. + + + + Image animation options in an Overlay Form. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets the time required to rotate image 360 degrees. + + The time required to rotate image 360 degrees, in milliseconds. + + + + Gets the number of frames required to rotate image 360 degrees. + + The number of frames required to rotate image 360 degrees. + + + + A handle for an Overlay Form. + + + + + Closes the Overlay Form. + + + + + Specifies an action executed when the Overlay Form is closed. + + An action executed when the Overlay Form is closed. + + + + Allows you to specify the control that should be focused when the Overlay Form is closed. + + A handle of the control that should be focused when the Overlay Form is closed. + true if the control is successfully specified; otherwise, false. + + + + Allows you to specify the control that should be focused when the Overlay Form is closed. + + The control that should be focused when the Overlay Form is closed. + true if the control is successfully specified; otherwise, false. + + + + Represents a set of options that specify a line wait indicator in an Overlay Form. + + + + + Initializes a new instance of the class with specified settings. + + The number of dots. + The dot size. + The distance between dots. + + + + Determines whether two object instances are equal. + + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Determines whether two object instances are equal. + + The object to compare with the current object. + true if the specified object is equal to the current object; otherwise, false. + + + + Serves as a hash function. + + A hash code for the current object. + + + + Gets the distance between dots. + + A value that specifes the distance between dots. + + + + Gets the number of dots. + + A value that specifies the number of dots. + + + + Gets the size of dots. + + A value that specifies the size of dots. + + + + Represents a set of options that specify an Overlay Form + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets whether the wait indicator is a rotating image or dots arranged in a line. + + A value that specifies the wait indicator. + + + + Gets or sets the background color. + + The background color. + + + + Gets or sets an object used to paint a form. + + An object that implements a custom paint logic. + + + + Gets the default options. + + An object that specifies the default options. + + + + Gets or sets whether the Overlay Form receives focus and disables user input on the overlapped control. + + true if the Overlay Form disables user input on the overlapped control; otherwise, false. + + + + Gets or sets whether to use the fade-in effect to show the form. + + true, to use the fade-in effect; otherwise, false. + + + + Gets or sets whether to use the fade-out effect to close the form. + + true, to use the fade-out effect; otherwise, false. + + + + Gets or sets the foreground color. + + The foreground color. + + + + Gets or sets a custom rotating image. + + A custom rotating image. + + + + Gets or sets the size of the predefined rotating image. + + The image size. + + + + Gets or sets the number of dots, their size, and distance between them in a line wait indicator. + + A value that specifies the number of dots, their size, and distance between them. + + + + Gets or sets the form opacity.’ + + The form opacity. 0 corresponds to total transparency; 1, to the normal state. + + + + Gets or sets the rotation period and the number of frames in a single rotation. + + An object that specifies the rotation period and the number of frames in a single rotation. + + + + Gets or sets the name of the skin applied to the form. + + The skin name. + + + + Gets or sets the delay before the form is shown. + + The delay before the form is shown. + + + + Gets or sets whether DirectX is used to render an Overlay Form. + + true, to use DirectX; false, to use GDI+; null to use the default engine. The default engine is DirectX if the Use DirectX option is enabled in the Project settings; otherwise, the default engine is GDI+. + + + + Enumerates values that specify whether the form under the wait form is enabled. + + + + + The form under the wait form is disabled. + + + + + The form under the wait form is enabled. + + + + + Contains values that specify how a is displayed, as a form or as an image. + + + + + Displays a splash form. + + + + + Displays the default or custom image specified in SplashScreen.SplashImageOptions. Fade effects are not supported in Image display mode. + + + + + Contains appearance settings for splash forms. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + A parent form for a splash form. + true, to use the fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use the fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + true, to use the glow effect when displaying a splash form; otherwise, false. This value is assigned to the SplashFormProperties.AllowGlowEffect property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form. + true, to use the fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use the fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + true, to use the glow effect when displaying a splash form; otherwise, false. This value is assigned to the SplashFormProperties.AllowGlowEffect property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form. + true to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + Initializes a new instance of the class with the specified settings. + + A parent form for a splash form. + true to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + + + + Initializes a new instance of the class and allows you to enable and disable fade-in and fade-out effects. + + A parent form for a splash form. + true to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + false to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form. + An Image object. + true, to use the fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use the fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + An ICustomImagePainter object that implements a custom drawing procedure. This object is assigned to the SplashFormProperties.CustomImagePainter property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + true, to use the glow effect when displaying a splash form; otherwise, false. This value is assigned to the SplashFormProperties.AllowGlowEffect property. + The delay, in milliseconds, that should elapse before the splash form is actually closed. This value is assigned to the SplashFormProperties.ClosingDelay property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form. + An Image object. + true, to use the fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use the fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + An ICustomImagePainter object that implements a custom drawing procedure. This object is assigned to the SplashFormProperties.CustomImagePainter property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + true, to use the glow effect when displaying a splash form; otherwise, false. This value is assigned to the SplashFormProperties.AllowGlowEffect property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form. + An Image object. + true, to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + An ICustomImagePainter object that implements a custom drawing procedure. This object is assigned to the SplashFormProperties.CustomImagePainter property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + Initializes a new instance of the class with the specified settings. + + A parent form for a splash form. + An Image object. + true, to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + An ICustomImagePainter object that implements a custom drawing procedure. This object is assigned to the SplashFormProperties.CustomImagePainter property. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + + + + Initializes a new instance of the class with the specified settings. + + A parent form for a splash form. + An Image object. + true, to use the fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + true, to use the fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + true, to use the glow effect when displaying a splash form; otherwise, false. This value is assigned to the SplashFormProperties.AllowGlowEffect property. + + + + Initializes a new instance of the class with the specified settings. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + A parent form for a splash form to be displayed. + An Image object. + true to use a fade-in effect when a splash form is displayed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeInEffect property. + false to use a fade-out effect when a splash form is closed; otherwise, false. This value is assigned to the SplashFormProperties.UseFadeOutEffect property. + + + + Gets or sets whether the splash form is displayed using the glow effect. + + true if the splash form is displayed using the glow effect; otherwise, false. + + + + Creates and returns a copy of the current object. + + A copy of the current object. + + + + Gets or sets the delay, in milliseconds, before the splash form is closed. + + An integer value that specifies the delay, in milliseconds, before the splash form is closed. + + + + Gets or sets an object that implements a custom drawing procedure. + + An ICustomImagePainter that implements a custom drawing procedure. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + An Image object. + + + + Gets the parent form for a splash form to be displayed. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The parent form for a splash form to be displayed. + + + + Gets the handle of the parent window. + + An IntPtr structure that identifies the handle of the parent window. + + + + Gets or sets whether to use a fade-in effect when a splash form is being opened. + + true to use a fade-in effect when a splash form is being opened; otherwise, false. + + + + Gets or sets whether to use a fade-out effect when a splash form is being closed. + + true to use a fade-out effect when a splash form is being closed; otherwise, false. + + + + Enumerates values that specify the screen position where a splash screen/wait indicator is displayed. + + + + + A splash screen/wait form is displayed at the center of the screen. + + + + + The position is not specified explicitly. If the main application form is not yet displayed, the splash form is shown at the center of the screen. If the main application form is already displayed, the splash form is centered relative to the active form. If the parentForm parameter of a method that shows a wait form is specified, the wait form is centered relative to the parent form. + + + + + To specify the position, use the SplashScreenManager.SplashFormLocation property or the location parameter of a method that shows the splash form. + + + + + The default splash screen managed by the component. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether custom controls can be added to the when SplashScreen.ShowMode is set to ShowMode.Image. + + true if custom controls can be added to the when SplashScreen.ShowMode is set to ShowMode.Image; otherwise, false. + + + + Get or sets if the is resized to fit its SplashScreen.SplashImage when displayed in Image mode. + + true if the is resized to fit its SplashScreen.SplashImage when displayed in Image mode; otherwise, false. + + + + Gets or sets whether to display the splash screen as a form or as the form’s image specified by . + + A enumeration value that specifies whether to display the splash screen as a form or as the form’s image. + + + + Gets or sets an image displayed as a splash screen. The image is displayed if is set to . + + An Image to be displayed in the ShowMode.Image display mode. + + + + Provides access to options that specify an image displayed as a splash screen. The image is displayed if is set to . + + An ImageOptions object that specifies the splash screen image. + + + + Allows you to create and show splash screens and wait forms. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified settings. + + The type of a splash form to be displayed. + A object used to initialize the SplashScreenManager.Properties property. + + + + Initializes a new instance of the class with specific settings. + + The type of splash form to be displayed. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + A object used to initialize the SplashScreenManager.Properties property. + A ParentFormState enumeration value that specifies whether the parent form is enabled while the splash form is displayed. + + + + Initializes a new instance of the class with specific settings. + + The type of splash form to be displayed. + The splash form’s arrangement. + Coordinates at which the splash form is shown. + A object used to initialize the SplashScreenManager.Properties property. + + + + Initializes a new instance of the class with specific settings. + + A Form relative to which the displayed splash form is positioned. This parameter is in effect when displaying s. + The type of a splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + true, to use the glow effect when displaying the form; otherwise, false. + + + + Initializes a new instance of the class with specific settings. + + A Form relative to which the displayed splash form is positioned. This parameter is in effect when displaying s. + The type of a splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. + + + + Initializes a new instance of the class with specific settings. + + A Form relative to which the displayed splash form is positioned. This parameter is in effect when displaying s. + The type of splash form to be displayed. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Initializes a new instance of the class with the specified settings. + + A Form relative to which the displayed splash form is positioned. This parameter is in effect when a is displayed. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + true, to use the glow effect when displaying the splash form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A Form relative to which the displayed splash form is positioned. This parameter is in effect when a is displayed. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + An integer value that specifies the delay, in milliseconds, before the form is closed. + + + + Initializes a new instance of the class with the specified settings. + + A parent form for the created splash form. + The type of a splash form to be displayed. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when hiding the form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + A ParentType enumeration value specifying whether the parent is a Form or UserControl. + true, to use the glow effect when displaying the splash form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl that owns the newly created . + A Type enumerator value specifying the type of splash form to be displayed. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when closing the form; otherwise, false. + A ParentType enumerator, specifying whether the parent is a Form or UserControl. + + + + Initializes a new instance of the class with specific settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + A ParentType enumeration value specifying whether the parent is a Form or UserControl. + true, to use the glow effect when displaying the splash form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl that owns the newly created . + A Type enumerator value specifying the type of splash form to be displayed. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + A ParentType enumerator, specifying whether the parent is a Form or UserControl. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + The Type of the parent object. The parent should be either a Form or a UserControl. Otherwise, ArgumentException is thrown. + true, to use the glow effect when displaying the splash form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + The Type of the parent object. The parent should be either a Form or a UserControl. Otherwise, ArgumentException is thrown. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The Type of the parent object. The parent should be either a Form or a UserControl. Otherwise, ArgumentException is thrown. + true, to use the glow effect when displaying the splash form; otherwise, false. + + + + Initializes a new instance of the class with the specified settings. + + A UserControl contained on the Form, against which the splash form is centered. + The type of splash form to be displayed. + true, to use the fade-in effect when opening the form; otherwise, false. + true, to use the fade-out effect when closing the form; otherwise, false. + The Type of the parent object. The parent should be either a Form or a UserControl. Otherwise, ArgumentException is thrown. + + + + Gets or sets whether a splash form’s parent is activated on closing the splash form. + + true if a splash form’s parent is activated on closing the splash form; otherwise, false. + + + + Gets or sets whether a ‘s parent is activated on closing the . + + true if a WaitForm’s parent is activated on closing the WaitForm; otherwise, false. + + + + Gets or sets the type of the splash form to be displayed by the . + + A TypeInfo object that specifies the type of the splash form to be displayed by the . + + + + Gets or sets the apartment state of the splash screen’s thread. + + A System.Threading.ApartmentState enumeration value that specifies the apartment state. + + + + Closes the wait form or splash screen. Throws an exception if no splash form is opened. + + + + + Closes the wait form or splash screen. + + true to raise an exception if no splash form is opened; otherwise, false. + true to block the current thread until the splash form is closed; otherwise, false. + + + + Closes the wait form or splash screen. For internal use. + + true to raise an exception if no splash form is opened; otherwise, false. + An integer value that specifies the amount of time (in milliseconds) that should elapse before the splash form is closed. + A form that is activated after the splash form is closed. This parameter is only in effect if the closingDelay parameter is greater than 0. + true to block the current thread until the splash form is closed; otherwise, false. + For internal use. + + + + Closes the wait form or splash screen after a delay. + + true to raise an exception if no splash form is opened; otherwise, false. + An integer value that specifies the amount of time (in milliseconds) that should elapse before the splash form is closed. + A form that is activated after the splash form is closed. This parameter is only in effect if the closingDelay parameter is greater than 0. + true to block the current thread until the splash form is closed; otherwise, false. + + + + Closes the wait form or splash screen after a delay. Allows you to select the form that should be subsequently activated, and suppress the exception raised if no splash form is opened. + + true to raise an exception if no splash form is opened; otherwise, false. + An integer value that specifies the amount of time (in milliseconds) that should elapse before the splash form is closed. + A form that is activated after the splash form is closed. This parameter is only in effect if the closingDelay parameter is greater than 0. + + + + Closes the displayed wait form or splash screen. Allows you to suppress the exception raised if no splash form is opened. + + true to raise an exception if no splash form is opened; otherwise, false. + + + + Closes the Overlay Form with the specified handle. + + An IOverlaySplashScreenHandle object specifying the handle of the Overlay Form to close. + + + + Closes the that was displayed using the SplashScreenManager.ShowWaitForm method. + + + + + Gets or sets the delay, in milliseconds, before the splash form is closed. + + An integer value that specifies the delay, in milliseconds, before the splash form is closed. + + + + Returns the default that allows you to interact with the currently displayed splash forms. + + A that is the default splash screen manager. + + + + Gets whether a splash form has been created, but not yet displayed. The splash form will be displayed a short time (pending time) after it has been created, provided that it is not closed during this time. + + A Boolean value that specifies whether a splash form has been created, but not yet displayed. + + + + Hides the splash image that has been displayed via the SplashScreenManager.ShowImage method. + + + + + Closes the currently displayed splash image after a specific delay and allows you to specify a form that should be subsequently selected. + + An Int32 value that is the number of milliseconds that elapses before the splash image is closed. + A Form object that should be activated after the splash form is closed. + + + + Forces the splash form to be redisplayed. + + + + + Gets whether a or is being currently displayed. + + true if a or is being currently displayed; otherwise, false. + + + + Gets or sets the name of the palette used to colorize vector images. + + A value that specifies the name of the palette used to colorize vector images. + + + + Contains properties controlling a form’s appearance. + + A object that contains appearance settings for splash forms. + + + + Registers a custom skin to be applied to a splash form. + + A SkinBlobXmlCreator object that contains skin data. + + + + Registers custom skins from the specified assembly to be applied to a splash form. + + An Assembly object that specifies the assembly containing custom skins to be applied to a splash form. + + + + Sends a command to the currently active splash form. + + An enumeration value that identifies the command to be sent to the currently active splash form. + The command’s parameter. + + + + Sets the active ‘s caption to the specified value. + + A string that is the new value for the active ‘s caption. + + + + Sets the active ‘s description to the specified value. + + A string that is the new value for the active ‘s description. + + + + Displays a Windows 10-inspired splash screen (features an Acrylic material effect - a partially transparent texture). + + An object that contains the splash screen’s settings. + The event handler to perform custom painting. + The splash screen’s owner. + A value that specifies whether to use the fade-in effect when the splash screen is being opened. + A value that specifies whether to use the fade-out effect when the splash screen is being closed. + true to throw an exception if another splash form has already been opened; false to suppress this exception. + A value that specifies how the form is positioned. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays a Windows 10-inspired splash screen (features an Acrylic material effect - a partially transparent texture). + + A string displayed in the title region. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the subtitle region. If this parameter is not specified (null), the subtitle region displays the value of the AssemblyCompany attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the left footer. If this parameter is not specified (null), the left footer displays the value of the AssemblyCopyright attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the right footer. If this parameter is not specified (null), the right footer displays the value of the AssemblyFileVersion attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + The opacity level for the splashscreen’s background. This setting is supported if the application runs under Windows 10 Version 1803 (OS build 17134) or newer. On older Windows versions, the splashscreen fills its background with a non-trasparent color (the ‘opacityColor’ parameter). + The background color. If the opacityColor parameter is set to Color.Empty, the actual background color is Color.Black. + The loading indicator kind to use. + The object to specify the logo image and its settings. + The event handler to perform custom painting. + The splash screen’s owner. + A value that specifies whether to use the fade-in effect when the splash screen is being opened. + A value that specifies whether to use the fade-out effect when the splash screen is being closed. + true to throw an exception if another splash form has already been opened; false to suppress this exception. + A value that specifies how the form is positioned. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + true if the manager uses a glow effect to display the splash form; otherwise, false. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. For internal use. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + For internal use. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + true if the manager uses a glow effect to display the splash form; otherwise, false. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. For internal use. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + For internal use. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. For internal use. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + For internal use. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + true if the manager uses a glow effect to display the splash form; otherwise, false. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + The time delay (in milliseconds) before the splash form is displayed. If the method is called at this time, the splash form is not displayed. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + true to throw if another splash form is already displayed; false to suppress the exception. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + + + + Creates and displays a splash form (wait form or splash screen) of the specified type. + + The splash form’s parent form. The wait form is centered relative to the parent. The parent form is activated when the splash form is closed. If the parent form is not specified, the manager shows the wait form over the active (top-level) form or activates the main application form. + The type of the object that specifies the splash form to be displayed. You can pass the type of a or descendant. + + + + Creates and displays a wait form of the specified type. + + A object that specifies a user control. The manager displays the wait form over the form that contains the specified control. This parameter is only in effect for wait forms. + The type of the object that specifies the wait form to be displayed. You can pass the type of a descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a wait form of the specified type. + + A object that specifies a user control. The manager displays the wait form over the form that contains the specified control. This parameter is only in effect for wait forms. + The type of the object that specifies the wait form to be displayed. You can pass the type of a descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + if the parent form is disabled while the wait form is displayed; otherwise, . This parameter is only in effect when a wait form is displayed. + + + + Creates and displays a wait form of the specified type. + + A object that specifies a user control. The manager displays the wait form over the form that contains the specified control. This parameter is only in effect for wait forms. + The type of the object that specifies the wait form to be displayed. You can pass the type of a descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + The screen coordinates of the splash form’s upper-left corner (if the startPos parameter is set to ). + + + + Creates and displays a wait form of the specified type. + + A object that specifies a user control. The manager displays the wait form over the form that contains the specified control. This parameter is only in effect for wait forms. + The type of the object that specifies the wait form to be displayed. You can pass the type of a descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + The position where the splash form is displayed. to display the wait form over the parent form (the splash screen - over the active form) or in the center of the screen if the main application form is not yet displayed. + to specify the splash form’s upper-left corner coordinates in the location parameter. + + + + Creates and displays a wait form of the specified type. + + A object that specifies a user control. The manager displays the wait form over the form that contains the specified control. This parameter is only in effect for wait forms. + The type of the object that specifies the wait form to be displayed. You can pass the type of a descendant. + true if the manager uses a fade-in effect when it shows the splash form; otherwise, false. + true if the manager uses a fade-out effect when it closes the splash form; otherwise, false. + + + + Displays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + An ICustomImagePainter object that implements a custom drawing procedure. + + + + Creates a splash form with a vector image inside and displays this form after the specified delay. Allows you to draw custom graphics over the splash image, manually arrange it, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + The time in milliseconds that should elapse before the splash form is actually displayed on-screen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + + + + Displays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, manually arrange it, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + + + + Displays a splash form that contains a vector image. Allows you to manually arrange this splash form. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays a vector image as a splash form with optional fade-in and fade-out effects. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + + + + Displays a vector image with an optional fade in effect. + + An SvgImage to be drawn. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + + + + Displays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, resize the image, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + An ICustomImagePainter object that implements a custom drawing procedure. + + + + Creates a splash form with a vector image inside and displays this form after the specified delay. Allows you to draw custom graphics over the splash image, resize and manually arrange it, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + The time in milliseconds that should elapse before the splash form is actually displayed on-screen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + + + + Displays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, resize and manually arrange it, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + + + + Displays a splash form that contains a vector image. Allows you to manually arrange this splash form, resize the image, and enable fade-in and fade-out effects. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays a vector image as a splash form, centering the image against your application’s main form. Allows you to disable fade-in and fade-out effects for the image. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + + + + Resizes an image and shows it as a splash form with an optional fade-in effect. + + An SvgImage to be drawn. + A Size structure that is the image size. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + + + + Resizes the target vector image and shows it as a splash form. + + An SvgImage to be drawn. + A Size structure that is the image size. + + + + Displays a vector image as a splash form, centering the image against your application’s main form. + + An SvgImage to be drawn. + + + + Displays an image as a splash form, centering the image against your application’s main form. + Allows you to disable fade-in and fade-out effects for the image and draw custom graphics over the splash image. + + An Image to be displayed as a splash form. + true to use the fade-in effect when the image opens; otherwise, false. + true to use the fade-out effect when the image closes; otherwise, false. + An ICustomImagePainter object that implements a custom drawing procedure. + + + + This method supports the internal infrastructure, and is not intended to be used directly from your code. + + An Image to be displayed as a splash form. + true, to use the fade-in effect when the image appears on-screen; otherwise, false. + true, to use the fade-out effect when the image hides; otherwise, false. Use the SplashScreenManager.HideImage method to hide a splash form image. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + Creates a splash form containing the specified image and displays it after a delay. Allows you to manually position the splash form, disable fade-in and fade-out effects for the image and draw custom graphics over the splash image. + + An Image to be displayed as a splash form. + true to use the fade-in effect when opening the image; otherwise, false. + true, to use the fade-out effect when the image closes; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + The time in milliseconds that should elapse before the splash form is actually displayed onscreen. If a close command is sent to the splash form during this time, the splash form will not be displayed. + + + + Displays an image as a splash form, allowing you to manually position it against your application’s main form. Allows you to disable fade-in and fade-out effects for the image and draw custom graphics over the splash image. + + An Image to be displayed as a splash form. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + An ICustomImagePainter object that implements a custom drawing procedure. + + + + Displays an image as a splash form, allowing you to manually position it. Allows you to disable fade-in and fade-out effects for the image. + + An Image to be displayed as a splash form. + true to use the fade-in effect when opening the form; otherwise, false. + true to use the fade-out effect when closing the form; otherwise, false. + The splash form’s arrangement. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays an image as a splash form, centering the image against your application’s main form. Allows you to disable fade-in and fade-out effects for the image. + + An Image to be displayed as a splash form. + true to use the fade-in effect when the image opens; otherwise, false. + true to use the fade-out effect when the form closes; otherwise, false. + + + + Displays an image as a splash form, centering the image against your application’s main form. + + An Image to be displayed as a splash form. + true to use the fade-in effect during the image’s opening; otherwise, false. + + + + Displays an image as a splash form, centering the image against your application’s main form. + + An Image to be displayed as a splash form. + + + + Shows an Overlay Form with the specified options over the specified control. + + A Control that should be overlapped by an Overlay Form. + An OverlayWindowOptions object that specifies the Overlay Form options, such as the loading image, fade animation and colors. + A handle for the shown Overlay Form. Use this handle to close the Overlay Form. + + + + Shows an Overlay Form with the default options over the specified control. + + A Control that should be overlapped by an Overlay Form. + A handle for the Overlay Form shown. Use this handle to close the Overlay Form. + + + + Displays a skin-aware splash screen with the specified SVG logo image. The current skin determines the background and font settings splash screen elements. + + The logo image in SVG format. + The display size of the SVG image. + A string displayed in the title region. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the subtitle region. If this parameter is not specified (null), the subtitle region displays the concatenation of the “Version “ string and the value of the AssemblyFileVersion attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the footer. If this parameter is not specified (null), the footer displays the concatenation of the AssemblyCopyright attribute value (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file) and the “All Rights Reserved.” string. + The text displayed above the progress bar. + The splash screen’s owner. + A value that specifies whether to use the fade-in effect when the splash screen is being opened. + A value that specifies whether to use the fade-out effect when the splash screen is being closed. + true to throw an exception if another splash form has already been opened; false to suppress this exception. + A value that specifies how the form is positioned. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays a skin-aware splash screen with the specified raster logo image. The current skin determines the background and font settings of the splash screen’s elements. + + The logo image. + A string displayed in the title region. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the subtitle region. If this parameter is not specified (null), the subtitle region displays the concatenation of the “Version “ string and the value of the AssemblyFileVersion attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the footer. If this parameter is not specified (null), the footer displays the concatenation of the AssemblyCopyright attribute value (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file) and the “All Rights Reserved.” string. + The text displayed above the progress bar. + The splash screen’s owner. + A value that specifies whether to use the fade-in effect when the splash screen is being opened. + A value that specifies whether to use the fade-out effect when the splash screen is being closed. + true to throw an exception if another splash form has already been opened; false to suppress this exception. + A value that specifies how the form is positioned. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Displays a skin-aware splash screen. The current skin determines the background and font settings of the splash screen’s elements. + + A string displayed in the title region. If this parameter is not specified (null), the title region displays the value of the AssemblyTitle attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the subtitle region. If this parameter is not specified (null), the subtitle region displays the concatenation of the “Version “ string and the value of the AssemblyFileVersion attribute (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file). + A string displayed in the footer. If this parameter is not specified (null), the footer displays the concatenation of the AssemblyCopyright attribute value (see your project’s AssemblyInfo.cs/AssemblyInfo.vb file) and the “All Rights Reserved.” string. + The text displayed above the progress bar. + The splash screen’s owner. + A value that specifies whether to use the fade-in effect when the splash screen is being opened. + A value that specifies whether to use the fade-out effect when the splash screen is being closed. + true to throw an exception if another splash form has already been opened; false to suppress this exception. + A value that specifies how the form is positioned. + Coordinates at which the splash form is shown (if the startPos parameter is set to Manual). + + + + Creates and displays a , whose type is specified by the SplashScreenManager.ActiveSplashFormTypeInfo property. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the screen coordinates at which a splash form ( or ) will be displayed. + + A Point structure specifying the screen coordinates at which a splash form ( or ) will be displayed. + + + + Gets or sets the arrangement of a splash form ( or ). + + A SplashFormStartPosition enumerator value specifying the arrangement of a splash form ( or a ). + + + + Blocks the current thread until the active splash form is closed. + + + + + Enumerates values that specify the wait indicator in an Overlay Form. + + + + + A rotating image. The actual image depends on the skin. + + + + + + Dots arranged in a line. + + + + + + Contains the classes that maintain the XtraTabControl’s infrastructure. + + + + + Contains classes that implement a custom header button feature for a tab control. + + + + + A custom header button for tab controls. + + + + + Initializes a new instance. + + + + + Initializes a new instance. + + The predefined button type. + The button caption. Displayed when kind is Clear, Delete, DropDown, Ellipsis, Glyph, Minus, Ok, Plus, Redo, Search, Separator or Undo. + The button width. + true if the button is enabled; otherwise, false. + true if the button is visible; otherwise, false. + Image display options. + The button’s appearance options. + The button’s appearance options in the hovered state. + The button’s appearance options in the pressed state. + The button’s appearance options in the disabled state. + The button’s tooltip. + The button’s tag. + The button’s super tooltip. + + + + Initializes a new instance of the class with the specified settings. + + A ButtonPredefines enumeration value that specifies the surface icon of a button. + A String value that is the button caption. + An Int32 value that is the button width. + true if the button is enabled; otherwise, false. + true if the button is visible; otherwise, false. + An EditorButtonImageOptions object that stores image-related properties. + An assigned to this button. + A String value that is the button hint. + An Object that can be used to identify different buttons. + A that is the button super tip. + + + + Initializes a new instance with the specified settings. + + A value that specifies a button’s kind. This parameter initializes the EditorButton.Kind property. + A string value that specifies a button’s caption. This parameter initializes the EditorButton.Caption property. + An integer value that specifies a button’s width. This parameter initializes the EditorButton.Width property. + true if a button is enabled; otherwise, false. This parameter initializes the EditorButton.Enabled property. + true if a button is visible; otherwise, false. This parameter initializes the EditorButton.Visible property. + An value that specifies a button’s image alignment. This parameter initializes the EditorButton.ImageLocation property. + A button’s image. This parameter initializes the EditorButton.Image property. + An that specifies a button’s appearance. This parameter initializes the EditorButton.Appearance property. + A string value that specifies a button’s tooltip. This parameter initializes the EditorButton.ToolTip property. + An object value that specifies a button’s tag. This parameter initializes the EditorButton.Tag property. + A object that specifies a button’s extended tooltip. This parameter initializes the EditorButton.SuperTip property. + true if image transparency is supported; otherwise, false. This parameter initializes the EditorButton.EnableImageTransparency property. + + + + Initializes a new class instance with the specified kind. + + A value that specifies a kind of button. This parameter initializes the EditorButton.Kind property. + + + + Gets a collection that owns the custom header button. + + A object that is the collection that owns the current custom header button. + + + + Gets a custom header button’s index within the collection. + + An integer value that is the ‘s index within the collection. + + + + The property is not supported. + + + + + The property is not supported. + + + + + A custom header button collection for tab controls. + + + + + Initializes a new class instance. + + + + + Adds a custom button to the current button collection. + + A object that is the button that will be added. + An integer value that is a custom button’s index in the collection. + + + + Adds an array of custom buttons to the current button collection. + + A object array that consists of the buttons to be added. + + + + Copies buttons from the specified object to the current object. + + The object that is the source button collection. + + + + Locks this and prevents any visual updates for buttons in this collection. Call the CustomHeaderButtonCollection.EndUpdate method to unlock the collection and redraw its buttons. + + + + + Cancels the UI lock caused by the CustomHeaderButtonCollection.BeginUpdate method. + + + + + Occurs when the current custom header buttons collection is changed. + + + + + Gets a value that specifies if a custom header button belongs to the current collection. + + A object to locate in the collection. + true if a custom header button belongs to the current collection; otherwise, false. + + + + Unlocks the and redraws its buttons to reflect all modifications that have been made while the collection was locked. To lock a collection and prevent its buttons from excessive redraws, call the CustomHeaderButtonCollection.BeginUpdate method. + + + + + Gets the specified button’s position in the current . + + The object to locate. + The zero-based index of the button in the . + + + + Inserts a custom header button to the at the specified index. + + An integer value that is an index at which the custom header button is inserted. + A object that is the custom header button to be inserted. + + + + Gets a button from the button collection at the specified position. + + The zero-based index of the button to return. + A object at the specified position in the current collection. + + + + Returns the current object’s text representation. + + A string value that specifies the text representation of the current object. + + + + Gets the number of visible buttons in a button collection. + + The number of visible buttons in a button collection. + + + + Enumerates values that specify whether Close buttons are displayed in individual tab pages, the tab control’s header, or in both. + + + + + The default behavior determined by controls. + For a , the Close button within the tab control’s header is displayed as specified by the control’s HeaderButtonsShowMode property. Close buttons in individual pages are hidden. + For a in a , the Default option is equivalent to ClosePageButtonShowMode.InActiveTabPageHeaderAndOnMouseHover. + + + + + Close buttons are displayed in the tab control’s header, and within the active page. The visibility of the Close button within the tab control’s header is specified by the control’s HeaderButtonsShowMode property. + + + + + A Close button is displayed in the active page. The Close button in the control’s header is hidden. + + + + + Close buttons are displayed within an active tab, and within an inactive tab when the mouse is hovered over it. The visibility of the Close buttons within the tab control’s header is specified by the HeaderButtonsShowMode property. + + + + + Close buttons are displayed in all pages. The Close button in the control’s header is hidden. + + + + + Close buttons are displayed in all pages and in the control’s header. The visibility of the Close button within the tab control’s header is specified by the control’s HeaderButtonsShowMode property. + + + + + The Close button is displayed in the tab control’s header, as specified by the control’s HeaderButtonsShowMode property. + + + + + Provides data for the TabbedView.CustomDrawHeaderButton event. + + + + + Initializes a new instance of the class with specified settings. + + An object that provides access to the drawing surface. + An object that performs paint operations. + An object that contains information about the button being drawn. + + + + Gets the rectangle that specifies the bounds of the header button. + + A rectangle that specifies the bounds of the header button. + + + + Gets the button that is being drawn. + + An object that specifies the button that is being drawn. + + + + Provides access to the object that contains information about the button being drawn. + + An object that contains information about the button being drawn. + + + + Provides the appearance settings used to paint the elements in a tab page. + + + + + Initializes a new instance of the class. + + + + + Locks the object by preventing visual updates until the EndUpdate method is called. + + + + + Fires after the object’s settings have been changed. + + + + + Releases all the resources used by the current object. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets the appearance settings used to paint the tab page(s). + + An object which provides the appearance settings used to paint the tab page(s). + + + + Gets the appearance settings used to paint the header which corresponds to the currently active page. + + An object which provides the appearance settings used to paint the header of the active page. + + + + Gets the appearance settings used to paint the header which corresponds to a disabled page. + + An object which provides the appearance settings used to paint the header of a disabled page. + + + + Gets the appearance settings used to paint the page header over which the mouse pointer is currently hovering. + + An object which provides the appearance settings used to paint the hot-tracked page header. + + + + Gets the appearance settings used to paint the page’s client region. + + An object which represents the appearance settings used to paint the page’s client region. + + + + Restores all the appearance settings and usage options back to their default values and thus stops tab pages from using these appearance settings. + + + + + Tests whether the object should be persisted. + + true if the object should be persisted; otherwise, false. + + + + Provides members that indicate which tab headers should display their Pin Buttons. + + + + + A Default value. Acts identically to the PinPageButtonShowMode.InActiveTabPageHeaderAndOnMouseHover value. + + + + + Only an active tab page header should display a Pin Button. + + + + + Only active and hovered tab headers should display a pin button. + + + + + All existing tab headers should display a pin button. + + + + + Lists values that specify the manner in which tab buttons are shown within a tab header panel. + + + + + The Close button is always displayed within the page header panel. The Prev and Next buttons are displayed when the XtraTabControl.MultiLine property is set to false. + + + + + The option is equivalent to the TabButtonShowMode.WhenNeeded option. + + + + + Tab buttons are always hidden. + + + + + Tab buttons are automatically shown when the tab control’s width is insufficient to display all the page headers. + + + + + Provides data for the TabbedView.CustomDrawTabHeader event. + + + + + Initializes a new instance of the class with specified settings. + + An object that provides access to the drawing surface. + An object that performs paint operations. + An object that contains information about the tab being drawn. + An object that contains information about the row being drawn. + An object that contains information about the page being drawn. + + + + Gets the rectangle that specifies the bounds of the tab header. + + A rectangle that specifies the bounds of the tab header. + + + + Provides access to the drawing surface and a cache of pens, fonts, and brushes. + + An object that provides access to the drawing surface and a cache of pens, fonts, and brushes. + + + + Gets an object that contains information about the tab being drawn. + + An object that contains information about the tab being drawn. + + + + Draws the visual element according to the default algorithm. + + + + + Draws the visual element’s background according to the default algorithm. + + + + + Draws the visual element’s buttons according to the default algorithm. + + + + + Draws the visual element’s icon according to the default algorithm. + + + + + Draws the visual element’s text according to the default algorithm. + + + + + Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements. + + A template to draw. + The object that transfers mouse events from a control to a template instance. This allows you to switch visual states (regular, hovered, pressed, and others) of template elements. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Paints the required HTML template inside an element that raised this event. + + A template to draw. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Provides access to the drawing surface. + + An object that provides access to the drawing surface. + + + + Gets or sets whether the event is handled and prevents the default draw operation from being performed. + + true, to prevent the default draw operation from being performed; otherwise, false. + + + + Provides access to the object that performs paint operations. + + An object that performs paint operations. + + + + Provides access to the object that contains information about the page being drawn. + + An object that contains information about the page being drawn. + + + + Provides access to the object that contains information about the row being drawn. + + An object that contains information about the row being drawn. + + + + Lists values that specify the position of the tab headers in a tab control. + + + + + The tab headers are located along the bottom of the tab control. + + + + + + The tab headers are located along the left side of the tab control. + + + + + + The tab headers are located along the right side of the tab control. + + + + + + The tab headers are located along the top of the tab control. + + + + + + Contains values that specify if and when a control’s TabMiddleClick event fires. + + + + + The default behavior. For the , this option is equivalent to None. + + + + + A TabMiddleClick event fires on pressing the middle mouse button over a tab (before the button is released). + + + + + A TabMiddleClick event fires on clicking the middle mouse button over a tab (after the button is released). + + + + + A TabMiddleClick event does not fire. + + + + + Lists values that specify the orientation of the tab headers in a tab control. + + + + + The default behavior determined by controls. + For an , the orientation of the tab headers depends upon the XtraTabControl.HeaderLocation property’s value. If the tab headers are located across the bottom or top of the tab control, they are horizontally oriented. Otherwise, if the tab headers are located along the left or right side of the tab control, they are vertically oriented. + For a in a , the Default option is equivalent to Horizontal. + + + + + The tab headers are horizontally oriented. + + + + + + The tab headers are vertically oriented. + + + + + + Provides data for the XtraTabControl.Selecting and XtraTabControl.Deselecting events. + + + + + Initializes a new instance of the class with the specified settings. + + An object that represents the current page. + An integer value that specifies the index of the page. + A Boolean value that specifies whether the event must be canceled. + A value that identifies the action being performed on a tab page. + + + + Gets or sets whether the event must be canceled. + + true if the event must be canceled; otherwise, false. + + + + Represents the method for handling events which take a object as a parameter. + + An object that fires the event. + A object that contains data for the event. + + + + Provides data for the XtraTabControl.HotTrackedPageChanged and XtraTabControl.SelectedPageChanged events. + + + + + Initializes a new instance of the class. + + An object which represents the tab page previously processed. This value is assigned to the TabPageChangedEventArgs.PrevPage property. + An object which represents the tab page currently being processed. This value is assigned to the TabPageChangedEventArgs.Page property. + + + + Gets the tab page currently being processed. + + An object which represents the tab page currently being processed. + + + + Gets the previously processed tab page. + + An object which represents the tab page previously processed. + + + + Represents a method that will handle the XtraTabControl.HotTrackedPageChanged and XtraTabControl.SelectedPageChanged events. + + The event sender. Identifies the tab control that raised the event. + A object that contains event data. + + + + Provides data for the XtraTabControl.SelectedPageChanging event. + + + + + Initializes a new instance of the class with the specified settings. + + An object that represents the old page. + An object that represents the new page. + + + + Gets or sets whether the event must be canceled. + + true if the event must be canceled; otherwise, false. + + + + Represents the method for handling events which take a object as a parameter. + + An object that fires the event. + A object that contains data for the event. + + + + Provides data for the XtraTabControl.Selected and XtraTabControl.Deselected events. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the current page. + An integer value that specifies the index of the page. + A object that represents the action being performed on the page. + + + + Gets the action being performed on a tab. + + A value that identifies the action being performed on a tab. + + + + Gets the currently processed page. + + A object that represents the currently processed page. + + + + Gets the index of the current page. + + An integer that specifies the index of the current page. + + + + Represents the method for handling events which take a object as a parameter. + + An object that fires the event. + A object that contains data for the event. + + + + Lists values that specify the alignment of the images displayed within page headers. + + + + + Images are centered within page headers and the header’s caption is hidden. + + + + + Images are positioned on the right side of page headers. + + + + + Images are positioned on the left side of page headers. + + + + + The images are not displayed within page headers. + + + + + Contains classes that provide information to the XtraTabControl’s events. + + + + + Provides data for the XtraTabControl.CloseButtonClick event. + + + + + Initializes a new instance of the class with the specified settings. + + null if the TabControl’s Close button has been clicked. Otherwise, this refers to the page whose Close button has been clicked. This value is assigned to the ClosePageButtonEventArgs.PrevPage property. + The page whose Close button has been clicked. This value is assigned to the Page property. + + + + Returns null if the TabControl’s Close button has been clicked. Otherwise, this property returns the same value as the Page property. + + An object. + + + + Provides data for the XtraTabControl.CustomHeaderButtonClick event. + + + + + Initializes a new class instance with the specified button and page. + + A value that is a clicked button. The parameter initializes the CustomHeaderButtonEventArgs.Button property. + A object that is an active tab page. The parameter initializes the CustomHeaderButtonEventArgs.ActivePage property. + + + + Gets an active tab page within the tab control. + + An IXtraTabPage object that is an active tab page. + + + + Gets the currently processed custom header button. + + A object that is the currently processed custom header button. + + + + The method for handling the XtraTabControl.CustomHeaderButtonClick event, which takes a object as a parameter. + + The event source. Identifies the tab control that raised the event. + A object that contains event data. + + + + Provides data for the XtraTabControl.HeaderButtonClick event. + + + + + Initializes a new class instance with the specified button and page. + + A currently processed button. The parameter initializes the HeaderButtonEventArgs.Button property. + A currently processed page. The parameter initializes the HeaderButtonEventArgs.ActivePage property. + + + + Gets an active tab page within the tab control. + + An IXtraTabPage object that is an active tab page. + + + + Gets the currently processed header button. + + A TabButtons item that is the currently processed header button. + + + + Gets or sets whether the XtraTabControl.HeaderButtonClick event has been handled, and no default processing is required. + + true if the default event processing is not required; otherwise, false. + + + + The method for handling the XtraTabControl.HeaderButtonClick event, which takes a object as a parameter. + + The event source. Identifies the tab control that raised the event. + A object that contains event data. + + + + Displays tabbed pages where you can place your controls. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether all icons within the current should be painted in the pages’ foreground colors. + + true if all icons within the current should be painted in the pages’ foreground colors; otherwise, false. + + + + Gets or sets whether or not tabs recognize HTML tags in their captions. + + true if tabs can format their captions by using HTML tags; otherwise, false. + + + + Gets the appearance settings used to paint the XtraTabControl. + + A object which provides the appearance settings used to paint the tab control. + + + + Provides access to the properties that control the appearance of all the tab pages in the XtraTabControl. + + A object which provides appearance settings for all the tab pages. + + + + Gets or sets the background color of the tab control’s client region. + + A structure which specifies the background color of the tab control’s client region. + + + + Starts the tab control’s initialization. + + + + + Locks the , preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. + + + + + Gets or sets the tab control’s border style. + + A enumeration value specifying the tab control’s border style. + + + + Gets or sets the border style of all the tab pages. + + A enumeration value specifying the border style of all the tab pages. + + + + Returns information about the XtraTabControl elements located at the specified point. + + A structure which specifies test point coordinates relative to the tab control’s top-left corner. + A DevExpress.XtraTab.ViewInfo.XtraTabHitInfo object that contains information about the tab elements located at the test point. + + + + Returns the tab control’s size, calculated from the size of its page. + + A structure which represents the size of a tab page’s client region. + A structure which represents the tab control’s size, calculated from the size of its page. + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Occurs when the Close button displayed within the XtraTabControl’s header is clicked. + + + + + Gets or sets whether Close buttons are displayed in individual tab pages and the tab control’s header. + + A value that specifies the display mode for Close buttons. + + + + Gets the collection of controls owned by the current control. This property supports the internal infrastructure and is not intended to be used directly from your code. + + A NoSerializationControlCollection object. + + + + Allows you to custom paint header buttons (XtraTabControl.CustomHeaderButtons). + + + + + Allows you to custom paint tabs. + + + + + Occurs when a custom header button is clicked. + + + + + Provides access to the custom header button collection in the current tab control. + + The object providing access to custom header buttons for the tab control. + + + + Occurs after a page has been deselected. + + + + + Occurs when a page is about to be deselected, and allows cancellation of the operation. + + + + + Gets the bounds of the tab page’s client region. + + A structure which represents the bounding rectangle of the tab page’s client region. + + + + Ends the tab control’s initialization. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Gets or sets the index of the tab page whose header is the first visible header onscreen. + + A zero-based integer which specifies the index of the tab page whose header is the first visible header onscreen. + + + + This property is not supported by the class. + + + + + Gets or sets the control’s foreground color. + + A structure that represents the control’s foreground color. + + + + Gets or sets whether the page headers should be automatically stretched to fill the empty space in a tab row. + + A enumeration value which specifies whether the tab headers should be automatically stretched to fill the empty space in a tab row. + + + + Occurs when a built-in header button is clicked. + + + + + Gets the options that specify which tab buttons can be displayed within the header panel. + + A set of DevExpress.XtraTab.TabButtons flags that specify the visibility of tab buttons. + + + + Gets or sets a value specifying whether and when Close, Next and Prev buttons are displayed in the tab control’s header. + + A value that specifies whether and when tab buttons are displayed within the header. + + + + Gets or sets the position of the tab headers. + + A enumeration member which specifies the position of the tab headers. + + + + Gets or sets the orientation of the tab headers. + + A enumeration member which specifies the orientation of the tab headers. + + + + Fires after the hot-tracked page header has been changed. + + + + + Gets or sets the hot-tracked tab page. + + An object which represents the tab page currently hot-tracked. + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + Gets or sets the source of the images that can be displayed within page headers. + + A that is an image collection providing images for page headers. + + + + Gets a value indicating whether the tab control is currently being initialized. + + true if the tab control is being initialized; otherwise, false. + + + + Updates a tab control. + + + + + Provides access to the settings which control the tab control’s look and feel. + + A object whose properties specify the tab control’s look and feel. + + + + Makes the header of the specified page visible on-screen if it’s currently invisible. + + An object which represents the tab page. + + + + Gets or sets the maximum width of tab headers. + + An integer value that is the maximum width of tab headers. 0 if the width of tab headers is not limited. + + + + Gets or sets whether more than one row of tab headers can be displayed. + + A value which specifies whether more than one row of tab headers can be displayed. + + + + Gets the bounding rectangle of a tab page’s client region. + + A structure which represents the bounding rectangle of the tab page’s client region. + + + + Gets or sets the alignment of the image displayed within the page header. + + A enumeration member which specifies the image’s alignment. + + + + This member is not supported. + + A value specifying the name of the paint style applied to the tab control. + + + + Gets or sets whether right-to-left mirror placement is turned on. + + A enumeration value that specifies whether right-to-left mirror placement is turned on. + + + + Occurs after a page has been selected. + + + + + Fires when the tab change animation completes. + + + + + Fires after a new XtraTabControl page has been selected. + + + + + Allows you to prevent a specific tab page from being activated. + + + + + Gets or sets the currently selected tab page. + + An object which represents the tab page currently selected. + + + + Gets or sets the index of the currently selected tab page. + + A zero-based integer which specifies the index of the selected tab page. + + + + Occurs when a specific page is about to be selected, and allows cancellation of the operation. + + + + + Gets or sets whether a focus frame is displayed around the selected page header. + + A enumeration member which specifies whether a focus frame is displayed around the selected page header. + + + + Gets or sets whether the page headers are displayed. + + A enumeration member which specifies whether the page headers are displayed. + + + + Gets or sets whether the tab control can display tooltips. + + A enumeration member which specifies whether the tab control can display tooltips. + + + + Fires when an end-user presses the middle mouse button over a tab. To ensure that this event fires, set the XtraTabControl.TabMiddleClickFiringMode property to MouseDown or MouseUp. + + + + + Gets or sets if and when the XtraTabControl.TabMiddleClick event fires. + + A value that specifies if and when the XtraTabControl.TabMiddleClick event fires. + + + + Provides access to the tab control’s page collection. + + An object which represents a collection of tab pages within a tab control. + + + + Gets or sets the default width for all tab page headers. + + An integer value that specifies the default width for tab page headers. + + + + This property isn’t used. + + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of the hints displayed for a tab control. + + The component which controls the appearance and behavior of the hints displayed for the tab control. + + + + Provides access to parameters of the tab switch animation. + + An DevExpress.XtraTab.XtraTabControlTransition object that specifies parameters of the tab switch animation. + + + + Gets or sets whether the XtraTabControl uses the non-default painting mode. + + true if the XtraTabControl control uses the non-default painting mode; otherwise, false. + + + + Gets or sets whether the control is painted grayed out, when it’s in the disabled state. + + true if the control is painted grayed out, when it’s in the disabled state; otherwise, false. + + + + Gets or sets whether mnemonic characters are used to activate tab pages. + + true if mnemonic characters are used to activate tab pages; otherwise, false. + + + + Gets or sets an object which specifies the tab control’s painting style. + + A DevExpress.XtraTab.Registrator.BaseViewInfoRegistrator object or descendant which specifies the tab control’s painting style. + + + + Represents a single tab page. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets whether the current ‘s icon should be painted in the page’s foreground color. + + true if the current ‘s icon should be painted in the page’s foreground color; otherwise, false. + + + + This member overrides the property. + + A bitwise combination of the values. + + + + Provides access to the properties that control the tab page’s appearance. + + A object which provides the appearance settings for the tab page’s elements. + + + + Gets or sets whether the auto-size feature is enabled. This property is not supported by the class. + + true if the auto-size feature is enabled; otherwise, false. + + + + Gets or sets the auto-size mode. This property is not supported by the class. + + A value. + + + + Gets or sets the background color of the tab page’s client region. + + A structure which specifies the background color of the tab page’s client region. + + + + Specifies the background image for the control. This property is not supported by the class. Use the BackgroundImage property of the PageAppearance.PageClient object instead. + + A value. + + + + This member is not supported by the class. + + + + + This member overrides the property. + + A enumeration member which specifies the position and manner in which a control is docked. + + + + Gets or sets whether a tab page can be selected. + + true if a tab page is enabled and can be selected by an end-user or via code; otherwise, false. + + + + This property is not supported by the class. + + + + + Gets or sets the foreground color of the tab page’s client region. + + A structure which specifies the foreground color of the tab page’s client region. + + + + Gets or sets the image displayed within the tab page’s header. + + A object which represents the image displayed within the tab page’s header. + + + + Gets or sets the index of the image displayed within the tab page’s header. + + A zero-based integer value specifying the index of an image within the XtraTabControl.Images list. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.XtraTab.XtraTabPageImageOptions object that stores image-related options. + + + + Gets or sets padding for the image displayed in the page’s header. + + A System.Windows.Forms.Padding value that specifies padding for the image. + + + + Gets the source of images which provides images for tab pages. + + An which provides images for tab pages. + + + + Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. + + A structure which represents the upper-left corner of the control relative to the upper-left corner of its container. + + + + Provides access to look-and-feel settings of the current object. + + A object that stores look-and-feel settings. + + + + Gets or sets the maximum width of the current tab header. + + An integer value that is the maximum width of the current tab header. 0 if the maximum width of the tab header is specified by the XtraTabControl.MaxTabPageWidth property. + + + + Gets or sets whether a tab page can be selected. + + true if a tab page is enabled and can be selected by an end-user or via code; otherwise, false. + + + + Gets or sets whether the tab page is visible. + + true if the tab page is visible; otherwise, false. + + + + Gets or sets whether the page contains a Close button. + + A value that specifies whether a Close button is displayed in the tab. + + + + Gets or sets the control’s height and width. + + A object that represents the control’s height and width, in pixels. + + + + Starts the animation of an animated GIF file being displayed in the page’s header. + + + + + Stops animation of an animated GIF file being displayed in the tab page’s header. + + + + + Gets or sets a for the current tab page’s header. + + A object associated with the current tab page. + + + + Gets the tab control to which the tab page belongs. + + An object or descendant which owns the tab page. + + + + Gets or sets the tab order of the control within its container. + + A zero-based integer value specifying the control’s index within the set of controls included in the tab order. + + + + Gets or sets the header width for the current tab page. + + An integer value that specifies the width of the current tab page’s header. + + + + Gets or sets a value indicating whether an end-user can focus this page using the TAB key. + + true if an end-user can focus the page using the TAB key; otherwise, false. + + + + Gets or sets the tab page caption. + + A value which specifies the text displayed within the page header. + + + + Gets or sets a regular tooltip for the tab page. + + A value which specifies the regular tooltip for the tab page. + + + + Gets or sets the type of the tooltip icon to display in a regular tooltip. + + A enumeration value. + + + + Gets or sets a regular tooltip’s title. + + A string that specifies a regular tooltip’s title. + + + + This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. To specify the tab page’s visibility use the XtraTabPage.PageVisible property instead. + + true if the tab page is visible; otherwise, false. + + + + Represents a tab control’s page collection. + + + + + Initializes a new instance of the class with the specified owner. + + An object or descendant which represents the tab control that will own the new page collection. This value is assigned to the XtraTabPageCollection.TabControl property. + + + + Creates a new tab page with default settings and appends it to the collection. + + An object which represents the new tab page. + + + + Appends the specified page to the collection. + + An object which represents the new page. + + + + Creates a new tab page with the specified text and appends it to the collection. + + A value which specifies the page’s text. + An object which represents the new page. + + + + Appends an array of objects to the collection. + + An array of objects to append to the collection. + + + + Removes all objects from the instance. + + true, to release all resources used by the tab pages; otherwise, false. + + + + Fires after the page collection has been changed. + + + + + Indicates whether the collection contains the tab page specified. + + An object to locate in the collection. + true if the collection contains the specified tab page; otherwise, false. + + + + Returns the specified page’s position within the collection. + + An object which represents the page to be located. + An integer value representing the specified page’s zero-based index. -1 if the collection doesn’t contain the specified page. + + + + Adds the specified page to the collection at the specified position. + + An integer value representing the zero-based index at which the specified page should be inserted. If it’s negative or exceeds the number of elements within the collection an exception is thrown. + An object which represents the inserted page. + + + + Creates a new page with default settings and adds it to the collection at the specified position. + + An integer value representing the zero-based index at which the specified page should be inserted. If it’s negative or exceeds the number of elements within the collection an exception is thrown. + + + + Gets the tab page at the specified position within the collection. + + An integer value representing the zero-based index of the page. If it’s negative or exceeds the number of elements, an exception is raised. + An object which represents the tab page at the specified position. + + + + Moves the page to another position within the collection. + + A zero-based integer specifying the position within the collection to move the page to. + An object which represents the tab page to move. + + + + Removes the specified tab page from the collection. + + An object which represents the tab page to be removed from the collection. + true, to release all resources used by the tab page; otherwise, false. + + + + Removes the specified tab page from the collection. + + An object which represents the tab page to be removed from the collection. + + + + Gets the tab control which displays the pages in this collection. + + An object or descendant which represents the tab control that owns this page collection. + + + + Copies all items contained within this to a separate array. + + An array of objects owned by this . + + + + Contains classes that encapsulate Wait Forms. + + + + + Represents a control showing an await message to a user. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the acceleration for the wait indicator visual elements. + + A value that specifies the acceleration for the wait indicator visual elements. + + + + Gets or sets the number of wait indicator visual elements. + + An integer value that specifies the number of wait indicator visual elements. + + + + Gets or sets a custom image for the wait indicator visual elements. + + An object that specifies a custom image for the wait indicator visual elements. + + + + Gets or sets the speed for the wait indicator visual elements. + + A value that specifies the speed for the wait indicator visual elements. + + + + Gets or sets the amount of space, in pixels, between the wait indicator and text. + + An integer value that specifies the amount of space, in pixels, between the wait indicator and text. + + + + Contains appearance settings used to customize the appearance of the control’s ProgressPanel.Caption. + + A that contains settings to customize the appearance of the control’s ProgressPanel.Caption. + + + + Contains appearance settings used to customize the appearance of the control’s ProgressPanel.Description. + + A that contains settings to customize the appearance of the control’s ProgressPanel.Description. + + + + Gets or sets whether the panel’s height is calculated automatically based on the currently applied skin. + + true if the panel’s height is calculated automatically based on the currently applied skin; otherwise, false. + + + + Gets or sets whether the panel’s width is automatically adjusted to fit all the text. + + true if the panel’s width is automatically adjusted to fit the entire text; otherwise, false. + + + + Gets or sets the length, in pixels, of the bar wait indicator. + + An integer value that specifies the length, in pixels, of the bar wait indicator. + + + + Gets or sets the thickness, in pixels, of the bar wait indicator. + + An integer value that specifies the thickness, in pixels, of the bar wait indicator. + + + + Gets or sets whether the bar wait indicator moves with a uniform velocity or with acceleration. + + A DevExpress.Utils.Animation.MotionType enumeration type that specifies whether the bar wait indicator moves with a uniform velocity or with acceleration. + + + + Gets or sets the control’s border style. + + A enumeration value specifying the control’s border style. + + + + Gets or sets the control’s caption. + + A string that specifies the control’s caption. + + + + Gets or sets the vertical distance between the ProgressPanel.Caption and ProgressPanel.Description. + + An integer value that is the vertical distance between the caption and description. + + + + Gets or sets the alignment of the caption, description and wait indicator relative to the panel. + + A enumeration value that specifies the alignment of the caption, description and wait indicator relative to the panel. + + + + Gets the ProgressPanel.Caption property’s default value, which can be localized. + + + + + Gets the ProgressPanel.Description property’s default value, which can be localized. + + + + + Gets or sets the control’s description. + + A string that specifies the control’s description. + + + + Gets or sets the number of animation frames. + + An integer value that specifies the number of animation frames. + + + + Gets or sets the time between animation frames, in special units. + + An integer value that specifies the time between animation frames, in special units. + + + + Retrieves the size of a rectangular area into which the control can be fitted. + + The custom-sized area for the control. + A value. + + + + Gets or sets the horizontal distance between the control’s left edge and the image + + An integer value that is the horizontal distance between the control’s left edge and the image + + + + Gets the size of the control’s image. + + A Size of the control’s image. + + + + Gets or sets the height, in pixels, of elements composing the line wait indicator. + + An integer value that specifies the height, in pixels, of elements composing the line wait indicator. + + + + Gets or sets the shape of elements comprising the line wait indicator. + + A DevExpress.Utils.Animation.LineAnimationElementType enumeration value that specifies the shape of elements comprising the line wait indicator. + + + + Gets of sets the diameter, in pixels, of the circle wait indicator. + + An integer value that specifies the diameter, in pixels, of the circle wait indicator. + + + + Gets or sets whether the control’s ProgressPanel.Caption is visible. + + true if the control’s ProgressPanel.Caption is visible; otherwise, false. + + + + Gets or sets whether the control’s ProgressPanel.Description is visible. + + true if the control’s ProgressPanel.Description is visible; otherwise, false. + + + + Gets or sets the horizontal distance between the image and text (caption plus description). + + An integer value that is the horizontal distance between the image and text (caption plus description) + + + + Returns the object which contains internal information used to render the control. + + A DevExpress.XtraWaitForm.ProgressPanelViewInfo object which contains internal information used to render the control. + + + + Gets or sets the wait animation’s type. + + The wait animation’s type. + + + + Contains values that specify a form’s Z-order relative to other forms. + + + + + A form is displayed topmost. + + + + + A form is displayed above its parent. + + + + + Specifies a form’s default position relative to other forms. + Currently, Default is equivalent to AboveParent. + + + + + This option applies the old algorithm that keeps a form above its parent. + + + + + A small form, designed to display the progress of a lengthy operation. The form’s display is managed by the component. + + + + + Initializes a new instance of the class. + + + + + Sets the ‘s caption to the specified value. + + A string that is the new value for the ‘s caption. + + + + Sets the ‘s description to the specified value. + + A string that is the new value for the ‘s description. + + + + Gets or sets above which windows the current is displayed. + + A enumerator value that specifies above which windows the current is displayed. + + + + This property is obsolete. Use the WaitForm.ShowOnTopMode property instead. + + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.dll new file mode 100644 index 0000000..3680872 Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.xml new file mode 100644 index 0000000..7cab843 --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.XtraLayout.v23.2.xml @@ -0,0 +1,6124 @@ + + + + DevExpress.XtraLayout.v23.2 + + + + + Contains classes that implement the control functionality. + + + + + Creates and maintains a consistent layout of controls for editing a specific data source’s fields. See Data Layout Control. + + + + + Initializes a new instance of the class. + + + + + Adds a layout item to the control and hides it. + + A descendant that represents the layout item to be added to the control and hidden. + + + + Gets or sets whether layout items that correspond to IList properties will be added to the generated layout. By default, these layout items will contain embedded s to display and edit IList object contents. + + True to generate layout items for IList properties; Default or False to exclude these properties from the generated layout. + + + + Gets or sets whether nested layout groups are generated to present fields of business object properties. + + True, if nested groups are generated for business object properties; Default or False if nested groups are not generated. + + + + Gets or sets whether a layout is re-built each time a new value is assigned to the DataLayoutControl.DataSource property. + + true if a layout is re-built each time a new value is assigned to the DataLayoutControl.DataSource property; otherwise, false. + + + + Gets an object that identifies which editors can be used to edit data of specific types. + + A DevExpress.XtraDataLayout.ControlsManager object. + + + + For internal use. + + + + + Gets an object that specifies the current data record. + + An object that specifies the current data record. + + + + Fires when the current position in the bound data source changes. + + + + + Gets or sets the index of the data record to be displayed in the control. + + An integer value that specifies the index of the data record to be displayed in the control. + + + + Gets or sets the data source member which supplies data to the ‘s editors. + + A string value representing the data source member. + + + + Gets or sets the data source providing data for editors that are created by the control. + + The object used as the data source. + + + + Fires after a layout is generated at runtime. Allows you to customize settings of individual generated layout items and editors. + + + + + Fires before a layout item with an embedded editor is generated and thus, prior to the editor’s data binding. It allows you to customize the type of editor to be generated, modify editor binding settings and hide certain editors. + + + + + Forces the control to finish its initialization. + + + + + Returns the nested control that is bound to the specified field. + + The name of the field to which the target control is bound. + The control bound to the specified field. The null value if no control is bound to this field. + + + + Returns the current record’s cell value in the specified data field. + + A string value that specifies the data field name. + An object that specifies the cell value. + + + + Returns the layout item whose control (LayoutControlItem.Control) is bound to the specified field. + + The name of the field to which the target layout item’s control is bound. + The layout item whose control (LayoutControlItem.Control) is bound to the specified field. The null value if no control is found. + + + + Returns information on the layout column count and binding settings of public properties in the data source. + + A value that specifies information on layout element binding settings. + + + + Returns the layout element binding information from the specified PropertyDescriptor collection. + + A collection of PropertyDescriptor objects. + A value that specifies the layout element binding information. + + + + Returns the number of records in the bound data source. + + The number of records in the bound data source. + + + + Creates layout items for all public fields in the bound data source. + + + + + Creates layout items for all public fields in the bound data source and allows you to customize general binding and layout settings. + + An object that provides additional binding and layout customization options. + + + + Assigns the specified value to the current record’s specified field. + + A string value that specifies the field name. + An object that specifies the assigned value. + + + + Gets or sets the site associated with the current . + + A System.ComponentModel.ISite object. + + + + Provides data for the event. + + + + + Initializes a new instance of the class. + + + + + Gets the control embedded in the layout item. + + The control embedded in the layout item. + + + + Gets the data source field to which the editor is bound. + + The bound data source field. + + + + Gets the created Layout Item. + + The created layout item. + + + + Gets a descendant that corresponds to the created editor. This property is in effect when a DevExpress editor ( descendant) is embedded in the created layout item. + + The Repository Item that corresponds to a DevExpress editor embedded in the created layout item. + + + + Provides data for the event. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the value used to initialize the Binding.DataSourceNullValue property for the auto-generated editor. + + The value used to initialize the Binding.DataSourceNullValue property of the auto-generated editor. + + + + Gets or sets the value used to initialize the Binding.DataSourceUpdateMode property for the auto-generated editor. + + The value used to initialize the Binding.DataSourceUpdateMode property of the auto-generated editor. + + + + Gets the bound field’s data type. + + The bound field’s data type. + + + + Gets or sets the type of the editor to be created. + + The type of the editor to be created. + + + + Gets the data source field to which the editor is bound. + + The bound data source field. + + + + Gets or sets whether the event is handled and the customized event parameters must be applied after the event handler is completed. + + true, to apply the customized event parameters after your event handler is completed; false, to discard the customizations made via the event. + + + + Gets or sets the name of the editor’s property to which the data source field is bound. + + The name of the editor’s property to which the data source field is bound. + + + + Gets or sets the layout item’s (editor’s) visibility. + + The layout item’s (editor’s) visibility. + + + + Contains parameters for the DataLayoutControl.RetrieveFields method. + + + + + Initializes a new instance of the class with the specified settings. + + + + + Gets or sets the number of columns in the layout that will be generated. + + An integer value that specifies the number of columns in the layout that will be generated. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the default value used to initialize the Binding.DataSourceNullValue property for all auto-generated editors. + This property identifies the value to be stored in the data source if the editor’s value is null or empty. + + The default value used to initialize the Binding.DataSourceNullValue property of all auto-generated editors. + + + + Gets or sets the default value used to initialize the Binding.DataSourceUpdateMode property for all auto-generated editors. + + This property indicates when changes to the bound editor property are propagated to the data source. + + The default value used to initialize the Binding.DataSourceUpdateMode property of all auto-generated editors. + + + + Contains the classes that encapsulate the Layout Control’s main functionality. + + + + + Obsolete. Instead use the options provided by the class. + + + + + This member is obsolete. Controls are aligned throughout the LayoutControl. + + + + + This member is obsolete. Controls are aligned independently within layout groups. + + + + + This member is obsolete. The auto-size feature is enabled. + + + + + Enumerates the options that specify how a ‘s size is changed when it is positioned within another LayoutControl. + + + + + The embedded LayoutControl’s size is fixed and is equal to its minimum size. + + + + + The embedded LayoutControl’s size can vary between its minimum and maximum sizes. + + + + + The embedded LayoutControl’s minimum size is restricted; while its maximum size is unlimited. + + + + + Represents the base class for layout items. + + + + + Invokes the Visit method of the specified visitor for each layout item that belongs to the current layout item. + + A DevExpress.XtraLayout.Utils.BaseVisitor class descendant. + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + Gets or sets whether the item can be hidden to the Customization Form. + + true if the item can be hidden to the Customization Form; otherwise, false. + + + + Gets the appearance settings used to paint a layout item’s caption. + + An object which provides the appearance settings used to paint the layout item’s caption. + + + + Assigns the specified object’s property values to the current object’s corresponding properties. + + The object whose property values to assign to the current object’s corresponding properties. + + + + Starts the component’s initialization. + + + + + Gets or sets the width of the current relative to other items’ width after the LayoutControl.BestFit method has been called. + + An Integer value that is the proportion of the current ‘s width to other items’ width after the LayoutControl.BestFit method has been called. + + + + Gets or sets the BindingContext for the item. + + A BindingContext for the item. + + + + Gets the layout item’s bounding rectangle. + + A structure that specifies the bounding rectangle. + + + + Returns whether the layout item can be moved to a specific position. + + A object whose settings determine the position to which the layout item should be moved. + true if the layout item can be moved to a specific position; otherwise, false. + + + + Fires when the current item is clicked. + + + + + Creates a copy of the current layout item. + + A object that represents the group to which the created layout item belongs. + An object that implements the DevExpress.XtraLayout.ILayoutControl interface, and owns the created layout item. + A object that represents an exact copy of the current instance. + + + + Allows you to custom paint the current item. + + + + + Gets or sets the layout item’s caption within the Customization Form. + + A string value that specifies the layout item’s caption within the Customization Form. + + + + Gets the data bindings for the layout item. + + A ControlBindingsCollection that contains the Binding objects for the item + + + + Fires when the current item is clicked. + + + + + Finishes the component’s initialization. + + + + + Not supported. + + Always True. + + + + Gets the default value of the BaseLayoutItem.Text property. + + A string that specifies the default value of the BaseLayoutItem.Text property. + + + + Returns the ‘s BaseLayoutItem.Text value without HTML tags and hotkey prefixes (the “&” symbol). + + The ‘s display text. + + + + Gets or sets the layout item’s height. + + An integer that specifies the layout item’s height. + + + + Fires after an item has been hidden. + + + + + Hides the item to the Customization Form. + + + + + Fires when the item is about to be hidden (when dragging the item and dropping it onto on the Customization Form). + + + + + Invalidates the region which is occupied by the layout item. + + + + + Gets whether the current item is being disposed of. + + true if the current item is being disposed of; otherwise, false. + + + + Gets whether the current layout item represents a Layout Group. + + true if the layout item represents a Layout Group; otherwise, false. + + + + Gets whether the layout item is hidden. + + true if the layout item is hidden; otheriwse, false. + + + + Gets whether the layout item has been locked for updating. + + true if the layout item is locked; otherwise, false. + + + + Gets or sets the coordinates of the layout item’s top left corner. + + A structure that specifies the coordinates of the layout item’s top left corner. + + + + Gets or sets the maximum size of the layout item. + + A structure that defines the item’s maximum width and height. + + + + Gets or sets the item’s minimum size. + + A structure that defines the item’s minimum width and height. + + + + Occurs when the mouse pointer is over a layout item and a mouse button is pressed. + + + + + Occurs when the mouse button is released if it was pressed within a layout item. + + + + + Moves the item to the specified visual position within the LayoutControl. + + A descendant that represents the layout item within the LayoutControl. + The item’s new position relative to the baseItem. + A enumeration value that specifies how a layout item is inserted in another position. + true if the item was successfully moved to a new position; otherwise, false. + + + + Moves the item to the specified visual position within the LayoutControl. + + A descendant that represents the layout item within the LayoutControl. + The item’s new position relative to the baseItem. + true if the item was successfully moved to a new position; otherwise, false. + + + + Moves the item to the specified position within the LayoutControl. + + A object whose settings determine the position to which the layout item should be moved. + true if the item was successfully moved to a new position; otherwise, false. + + + + Gets or sets the layout item’s name. + + A value that specifies the item’s name. + + + + Contains options that specify which operations can be performed on the layout item at runtime. + + A object that contains the corresponding options. + + + + This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. + + A BaseLayoutItemToolTipOptions object. + + + + This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. + + A BaseLayoutItemToolTipOptions object. + + + + Provides access to the options that specify how a layout item is arranged within a table layout. + + An object that contains the layout item’s arrangement options. + + + + Contains options that allow tooltips to be assigned to layout items and their images. + + A object providing corresponding options. + + + + Gets or set the LayoutControl that owns the current layout item. + + A LayoutControl control. + + + + Gets or sets the amount of space in pixels between the item’s borders and its contents. + + A DevExpress.XtraLayout.Utils.Padding object that contains inner indents between the layout item’s borders and its contents. + + + + Provides access to the appearance settings currently used to paint the layout item. + + An object that contains the corresponding appearance settings. + + + + Gets or sets the group that owns the current item. + + A or its descendant that owns the current item. + + + + Gets or sets the name of the item’s parent. + + A string that specifies the name of the item’s parent. + + + + Restores the current layout item from the Customization Form and adds it to the root group with the default layout type. + + + + + Restores the current layout item from the Customization Form and adds it to the parent group of the specified item at the specified visual position. + + A descendant which represents the layout item within the LayoutControl. + The position of the restored item relative to the baseItem. + + + + Restores the current layout item from the Customization Form and displays it at the specified position within the LayoutControl. + + A object whose settings determine the position to which the layout item should be moved. + + + + Restores the current layout item from the Customization Form and adds it to the specified group with the default layout type. + + A descendant which represents the layout group that the current layout item will be added to. + + + + Gets or sets the selection state of the current item. + + true if the current layout item is selected; otherwise, false. + + + + Gets or sets whether the layout item is displayed within the Customization Form when the item is hidden. + + true if the layout item is displayed within the Customization Form when it’s hidden; otherwise, false. + + + + Fires when the item is about to be added to the layout (by dragging it from the Customization Form). + + + + + Fires after an item has been made visible. + + + + + Gets or sets the layout item’s size. + + A structure that defines the item’s width and height. + + + + Gets or sets the outer indents of the item’s borders. + + A DevExpress.XtraLayout.Utils.Padding object that contains the outer indents of the layout item’s borders. + + + + Gets or sets whether the current item starts a new row within a flow layout. + + true if the layout item starts a new row within the flow layout; otherwise, false. + + + + Gets or sets an object that contains data on the current layout item. + + An object that contains data on the layout item. + + + + Gets or sets the caption of this layout item. If the Text property is null (Nothing in VB.NET) or String.Empty, this property returns the item name. + + A string that is the layout item’s text. + + + + Fires after the layout item’s text has been changed. + + + + + Gets or sets the item caption position. + + A value that specifies the item caption position. + + + + Gets or sets the size of the text region. + + A structure that defines the width and height of the item’s text region. + + + + Gets or sets the distance between the control displayed within the layout item and the text region. + + An integer that specifies the distance, in pixels. + + + + Gets or sets whether the text region is visible. + + true if the text region is visible; otherwise, false. For s, the TextVisible property’s default value +is dependent on the type of control embedded in this layout item. + + + + Gets the name of the current layout item’s type. + + A string that represents the name of the current layout item’s type. + + + + Updates the region occupied by the layout item. + + + + + Gets the object which contains the information used to render the layout item. + + A DevExpress.XtraLayout.ViewInfo.BaseLayoutItemViewInfo object. + + + + Allows you to hide the item from the Layout Control and Customization Form. + + A value that specifies whether the item is visible in the layout and the Customization Form. + + + + Gets whether the layout item is visible. + + true if the layout item is visible; otherwise, false. + + + + Gets or sets the layout item’s width. + + An integer that specifies the layout item’s width. + + + + Gets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner. + + An integer which specifies the X coordinate of the item’s top left corner. + + + + Gets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner. + + An integer which specifies the Y coordinate of the item’s top left corner. + + + + Contains options that specify which operations can be performed on a layout item at runtime. + + + + + Initializes a new instance of the class. + + A object that will own the created object. + + + + Gets or sets whether the current layout item/group can be dragged-and-dropped to another position. + + An ItemDragDropMode value that specifies whether the current item/group can be dragged-and-dropped to another position. + + + + Gets or sets whether other items can be dragged-and-dropped onto the current layout item/group. + + An ItemDragDropMode value that specifies whether other items can be dragged-and-dropped onto the current layout item/group. + + + + Copies options from the specified object to the current object. + + A descendant whose settings are assigned to the current object. + + + + Returns whether the layout item can be dragged-and-dropped to another position. + + true if the layout item can be dragged-and-dropped to another position; otherwise, false. + + + + Returns whether other layout items can be dragged-and-dropped onto the current layout item. + + true if other layout items can be dragged-and-dropped onto the current layout item; otherwise, false. + + + + Contains options that allow tooltips to be assigned to layout items. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether HTML formatting tags can be used to format the tooltip’s text. + + True if HTML formatting tags can be used to format the tooltip’s text; False if not; Default uses the ToolTipController.AllowHtmlText global setting. + + + + Copies options from the specified object to the current object. + + A descendant whose settings are assigned to the current object. + + + + Returns whether a tooltip for a layout item’s image can be displayed. + + true if a tooltip for a layout item’s image can be displayed; otherwise, false. + + + + Returns whether a tooltip for a layout item’s caption can be displayed. + + true if a tooltip for a layout item’s caption can be displayed; otherwise, false. + + + + Gets or sets whether a tooltip displayed for the layout item’s image is enabled. + + true if a tooltip displayed for the layout item’s image is enabled; otherwise, false. + + + + Gets or sets whether HTML tags can be used to format the tooltip text displayed for the item’s icon. + + True if HTML tags can be used to format the tooltip text; False if not; Default uses the ToolTipController.AllowHtmlText global setting. + + + + Gets or sets whether the tooltip for the layout item’s icon is displayed immediately or after a delay. + + true if the tooltip is displayed immediately; otherwise, false. + + + + Specifies the text of the tooltip displayed when the mouse cursor hovers over the layout item’s image. + + A string that specifies the tooltip’s text. + + + + Gets or sets the type of the icon for the tooltip that is displayed when the mouse cursor hovers over the layout item’s image. + + A value. + + + + Gets or sets the title of the tooltip that is displayed when the mouse cursor hovers over the layout item’s image. + + A string that specifies the tooltip’s title. + + + + Gets or sets whether the tooltip is displayed immediately or after a delay. + + true if the tooltip is displayed immediately; otherwise, false. + + + + This method supports the internal infrastructure and is not intended to be called directly from your code. + + An IComponent object. + A Boolean value. + + + + Specifies the text of the tooltip displayed when the mouse cursor hovers over the layout item’s caption, and by default over its image. + + A string that specifies the tooltip’s text. + + + + Gets or sets the type of the icon for the tooltip that is displayed when the mouse cursor hovers over the layout item’s caption, and by default over its image. + + A value. + + + + Gets or sets the title of the tooltip that is displayed when the mouse cursor hovers over the layout item’s caption, and by default over its image. + + A string that specifies the tooltip’s title. + + + + Defines a column in a table layout. + + + + + Initializes a new instance of a class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of a class with the specified settings. + + A layout group that owns the created object. + The width of the created column. This value is assigned to the ColumnDefinition.Width property. + The size type of the created column. This value is assigned to the ColumnDefinition.SizeType property. + + + + Initializes a new instance of a class with the specified owner. + + A layout group that owns the created object. + + + + Gets or sets the column’s size type in a table layout. + + A value that specifies the column’s size type. + + + + Gets or sets the column width, in pixels or as a percentage, according to the ColumnDefinition.SizeType. + + A value that specifies the column width. + + + + A column collection within a table layout. + + + + + Initializes a new instance of a class with the settings of the specified source object and with the specified owner. + + An object whose settings are used to initialize the created object. + A layout group that owns the created object. + + + + Initializes a new instance of a class with the specified owner. + + A layout group that owns the created object. + + + + Adds a specified column to the table layout. + + An object that specifies the column to be added. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + + + + Adds an array of columns to the table layout. + + An array of objects to be added to the table layout. + + + + Inserts an element into the collection at the specified index. + + The zero-based index at which a columnDefinition should be inserted. + The to insert. + true, to recalculate the OptionsTableLayoutItem.ColumnIndex property of items in the current layout group; otherwise, false. + + + + Provides indexed access to columns within the table layout. + + A zero-based integer value that specifies the index of the required column. + A column at the specified position within the collection. + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + true, to recalculate the OptionsTableLayoutItem.ColumnIndex property of items in the current layout group; otherwise, false. + + + + Contains values that specify how default maximum size constraints are calculated for controls that implement the interface. + + + + + The default maximum width is calculated for a control as the maximum of two values: Control.MaximumSize.Width and IXtraResizableControl.MaxSize.Width. + The default maximum height is calculated for a control as the maximum of two values: Control.MaximumSize.Height and IXtraResizableControl.MaxSize.Height. + + + + + The default maximum width and height are specified by the Control.MaximumSize.Width and Control.MaximumSize.Height values, respectively. + + + + + The default maximum width is specified by the Control.MaximumSize.Width property if it is not set to 0; otherwise, the default maximum width is specified by the IXtraResizableControl.MaxSize.Width property. + The default maximum height is specified by the Control.MaximumSize.Height property if it is not set to 0; otherwise, the default maximum height is specified by the IXtraResizableControl.MaxSize.Height property. + + + + + Contains values that specify how default minimum size constraints are calculated for controls that implement the interface. + + + + + The default minimum width is calculated for a control as the minimum of two values: Control.MinimumSize.Width and IXtraResizableControl.MinSize.Width. + The default minimum height is calculated for a control as the minimum of two values: Control.MinimumSize.Height and IXtraResizableControl.MinSize.Height. + + + + + The default minimum width and height are specified by the Control.MinimumSize.Width and Control.MinimumSize.Height values, respectively. + + + + + The default minimum width is specified by the Control.MinimumSize.Width property if it is not set to 0; otherwise, the default minimum width is specified by the IXtraResizableControl.MinSize.Width property. + The default minimum height is specified by the Control.MinimumSize.Height property if it is not set to 0; otherwise, the default minimum height is specified by the IXtraResizableControl.MinSize.Height property. + + + + + Contains classes used to convert layouts of controls. + + + + + Converts a regular layout of controls to the , and vice versa. + + + + + Contains classes that are used to customize the layout of the XtraLayout control. + + + + + Contains methods to move a layout item to a position next to another layout item. + + + + + Initializes a new instance with settings specifying that the dragItem should be inserted next to the baseItem, occupying its largest part (typically, half the region). + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object relative to which the dragItem will be positioned. This object is used to initialize the LayoutItemDragController.Item property. + A value that specifies whether the dragItem is inserted before or after the baseItem. This value is used to initialize the LayoutItemDragController.InsertLocation property. + A value that specifies whether the dragItem is inserted horizontally or vertically next to the baseItem. This value is used to initialize the LayoutItemDragController.LayoutType property. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object relative to which the dragItem will be positioned. This object is used to initialize the LayoutItemDragController.Item property. + A value that specifies whether the dragItem is inserted inside or outside the baseItem. This value is used to initialize the LayoutItemDragController.MoveType property. + A value that specifies whether the dragItem is inserted before or after the baseItem. This value is used to initialize the LayoutItemDragController.InsertLocation property. + A value that specifies whether the draItem is inserted horizontally or vertically next to the baseItem. This value is used to initialize the LayoutItemDragController.LayoutType property. + + + + Initializes a new instance with settings specifying that the dragItem should be inserted next to the baseItem. + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object relative to which the dragItem will be positioned. This object is used to initialize the LayoutItemDragController.Item property. + A value that specifies whether the dragItem is inserted inside or outside the baseItem. This value is used to initialize the LayoutItemDragController.MoveType property. + A value that specifies whether the dragItem is inserted before or after the baseItem. This value is used to initialize the LayoutItemDragController.InsertLocation property. + A value that specifies whether the dragItem is inserted horizontally or vertically next to the baseItem. This value is used to initialize the LayoutItemDragController.LayoutType property. + + + + Initializes a new instance with settings specifying that the_dragItem_ should be inserted horizontally after the baseItem, occupying its largest part (typically, half the region). + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object relative to which the dragItem will be positioned. This object is used to initialize the LayoutItemDragController.Item property. + + + + Initializes a new instance with settings specifying that the dragItem should be inserted next to another item, as specified by the settings of the controller parameter. + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object, whose settings determine how a dragItem is inserted next to another item. + + + + Initializes a new instance with settings specifying that the dragItem should be inserted at a certain position within a specific group. + + A object to be moved. This object is used to initialize the LayoutItemDragController.DragItem property. + A object into which the dragItem will be inserted. + A Point where the dragItem will be inserted into the group. + + + + Inserts the LayoutItemDragController.DragItem to a position, specified by the settings of the current object. This method cannot be used to move items that do not belong to a . + + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Gets the item to be inserted to a position, specified by the settings of the object. + + A object that represents the item to be inserted. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + Inserts the orphan LayoutItemDragController.DragItem to a position specified by the settings of the current object. This method cannot be used to move items that belong to a . + + true if the item has been successfully inserted; otherwise, false. + + + + Gets an object that identifies an element located at the LayoutItemDragController.HitPoint point. This member is in effect if the current object has been initiailized using a constructor with a Point parameter. + + A object that provides information on the element located at the LayoutItemDragController.HitPoint point. + + + + Gets the point at which the LayoutItemDragController.DragItem will be inserted. This member is in effect if the current object has been initialized using a constructor with a Point parameter. + + A Point at which the LayoutItemDragController.DragItem will be inserted. + + + + Gets whether the LayoutItemDragController.DragItem is inserted before or after the LayoutItemDragController.Item. + + A value that specifies whether the LayoutItemDragController.DragItem is inserted before or after the LayoutItemDragController.Item. + + + + Gets the item next to which the LayoutItemDragController.DragItem is inserted. + + A object that identifies the item next to which the LayoutItemDragController.DragItem is inserted. + + + + Gets whether the LayoutItemDragController.DragItem is inserted horizontally or vertically next to the LayoutItemDragController.Item. + + A value that specifies whether the LayoutItemDragController.DragItem is inserted horizontally or vertically next to the LayoutItemDragController.Item. + + + + Gets whether the LayoutItemDragController.DragItem is inserted inside or outside the LayoutItemDragController.Item. + + A value that specifies whether the LayoutItemDragController.DragItem is inserted inside or outside the LayoutItemDragController.Item. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + + + + For internal use. + + + + + Enumerates the runtime customization modes for a . + + + + + Default customization mode. Customization commands are provided using context menus. + + + + + Quick customization mode. Customization commands are available in the touch-friendly Customization Form. + + + + + The base class for Layout Control columns and rows in table layout mode. + + + + + Gets or sets whether the current row/column is visible. + + true if the row/column is visible; otherwise, false. + + + + Used to insert empty regions in the Layout Control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified parent group. + + A object that owns the created item. + + + + This property is not supported by the class. + + false. + + + + For internal use. + + + + + For internal use. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Not supported. + + null. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Not supported. + + A structure. + + + + Not supported. + + A structure. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Returns the default value of the BaseLayoutItem.Text property. + + A value that specifies the default value of the BaseLayoutItem.Text property. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets the maximum size of the . + + A structure that defines the item’s maximum width and height. + + + + Gets or sets the minimum size of the . + + A structure that defines the item’s minimum width and height. + + + + Not supported. + + The Locations.Default value. + + + + Not supported. + + Zero. + + + + Gets or sets whether the text region is visible. + + true if the text region is visible; otherwise, false. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the name of the item’s type. + + The EmptySpaceItem value. + + + + Contains the classes which provide the functionality used to determine the hit information in the XtraLayout control. + + + + + Contains information on a specific point within a Layout Control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class by copying the settings from the specified hitInfo object. + + A object whose settings are copied to the object being created. + + + + Initializes a new instance of the class with the specified settings. + + A structure that represents the test point. This value is assigned to the BaseLayoutItemHitInfo.HitPoint property. + A value that specifies the type of a layout item’s element located under the test point. This value is assigned to the BaseLayoutItemHitInfo.HitType property. + A object that represents the layout item located under the test point. This value is assigned to the BaseLayoutItemHitInfo.Item property. + + + + Gets the test point. + + A structure that specifies the current test point. + + + + Gets the type of the layout item’s element located under the test point. + + A value that specifies the type of the element located under the test point. + + + + Gets whether the test point belongs to a group’s expand button. + + true if the test point belongs to a group’s expand button; otherwise, false. + + + + Gets whether the current test point belongs to a Layout Group. + + true if the current test point belongs to a Layout Group; otherwise, false. + + + + Gets whether the test point belongs to a tab of a and this tab resides within the last tab row. This property is in effect if tabs are allowed to be arranged in multiple rows (see TabbedGroup.MultiLine). + + true if a tab resides within the last tab row; otherwise, false. + + + + Gets whether the current layout item is being or about to be resized by dragging the item’s border with the mouse. + + true if the current layout item is being or about to be resized; otherwise false. + + + + Gets whether the current test point belongs to a Tabbed Group. + + true if the current test point belongs to a Tabbed Group; otherwise, false. + + + + Gets the layout item (regular group or tabbed group) positioned under the test point. + + A descendant that specifies the layout item positioned under the test point. + + + + If the test point belongs to a tab page header, gets the index of the corresponding tab page. + + An integer which specifies the index of a tab page. -1 if the test point doesn’t belong to a tab page header. + + + + Lists the values that identify the Layout Control’s visual elements. + + + + + The test point belongs to a control which is located within a layout item. + + + + + A layout item is being or about to be resized horizontally. See the BaseLayoutItemHitInfo.IsSizing topic. + + + + + The test point belongs to a layout item, group or tabbed group. + + + + + The test point does not belong to any visual element or is outside the LayoutControl. + + + + + The test point belongs to a layout item’s text area. + + + + + A layout item is being or about to be resized vertically. See the BaseLayoutItemHitInfo.IsSizing topic. + + + + + Provides the appearance settings used to paint a LayoutControl. + + + + + Initializes a new instance of the class. + + + + + Gets the appearance settings used to paint the contents of all the editors owned by the LayoutControl. + + A object which provides the appearance settings used to paint the editor’s contents. + + + + Gets the appearance settings used to paint the contents of the editors owned by the LayoutControl when they are disabled. This option is only in effect for DevExpress controls that support the . + + A object which provides the appearance settings used to paint the contents of the editors when they are disabled. + + + + Gets the appearance settings used to paint the popup window of all the editors owned by the LayoutControl. + + A object which provides the appearance settings used to paint the editor’s popup window. + + + + Gets the appearance settings used to paint the header panel within the popup windows of all the editors owned by the LayoutControl. + + A object which provides the appearance settings used to paint the header panel within the popup window. + + + + Gets the appearance settings used to paint the currently focused editor within the LayoutControl. + + A object which provides the appearance setting used to paint the currently focused editor within the LayoutControl. + + + + Gets the appearance settings used to paint the contents of the editors owned by the LayoutControl when they are in the read-only state. This option is only in effect for DevExpress controls that support the mechanism. + + A object which provides the corresponding appearance settings. + + + + Gets the appearance settings used to paint captions of disabled layout groups. + + An object that contains corresponding appearance settings. + + + + Gets the appearance settings used to paint captions of disabled layout items or items that display disabled controls. + + An object that contains corresponding appearance settings. + + + + Creates and maintains a consistent layout of controls. See Layout and Data Layout Controls. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + true to allow use splitters; otherwise, false. + true to allow use tabbed groups; otherwise, false. + + + + This constructor supports the internal infrastructure, and is not intended to be used directly from your code. + + A Boolean value. + + + + Activates the layout control’s About dialog box. + + + + + Creates a new layout group with the default layout type and adds it to the root group. + + The newly created group. + + + + Creates a new layout group at a position relative to an item within the root group. + + A descendant (owned by the root group) next to which a new group is inserted. + The position of the new group relative to the baseItem. + The newly created group. + + + + Inserts the specified layout group at a position relative to an item within the root group. + + The group to add to the root group. + A descendant (owned by the root group) next to which the ‘newGroup’ is inserted. + The position of the new group relative to the baseItem. + The added group. + + + + Inserts the specified layout group to the root group. + + The group to add to the root group. + The added group. + + + + Creates a new layout group with the specified caption at a position relative to an item within the root group. + + A value that specifies the group’s caption. This value is assigned to the BaseLayoutItem.Text property. + A descendant (owned by the root group) next to which a new group is inserted. + The position of the new group relative to the baseItem. + The newly created group. + + + + Creates a new layout group with the default layout type and the specified caption, and adds it to the root group. + + A value that specifies the group’s caption. This value is assigned to the BaseLayoutItem.Text property. + The newly created group. + + + + Creates a new layout item with the default layout type and adds it to the root group. + + The newly created layout item. + + + + Inserts the specified layout item at a position relative to an item within the root group. + + The item to add to the root group. + A descendant (owned by the root group) next to which the ‘newItem’ is inserted. + The position of the new item relative to the baseItem. + The added item. + + + + Creates a new layout item at a position relative to another item within the root group. + + A descendant (owned by the root group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Inserts the specified layout item to the root group. + + The item to add to the root group. + The added item. + + + + Inserts the specified layout item at a position relative to another item within the root group. Allows a new text to be specified for the item. + + A value that specifies the new text to be assigned to the added item. The parameter is ignored if the value represents an empty string. + This parameter is ignored. + The item to add to the root group. + A descendant (owned by the root group) next to which the ‘newItem’ is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Creates a new layout item with the specified text and control, and adds it at a position relative to another item within the root group. + + A value that specifies the layout item’s text. + The control to display in the new layout item. This value is used to initialize the LayoutControlItem.Control property. + A descendant (owned by the root group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Creates a new layout item with the specified text and control, and adds it to the root group. + + A value that specifies the layout item’s text. + The control to display in the new layout item. This value is used to initialize the LayoutControlItem.Control property. + The newly created layout item. + + + + Creates a new layout item with the specified text and adds it to the root group. + + A value that specifies the layout item’s text. + The newly created layout item. + + + + Creates a new tabbed group with the default layout type and adds it to the root group. + + The newly created group. + + + + Creates a new tabbed group and adds it at a position relative to an item within the root group. + + A descendant (owned by the root group) next to which a new group is inserted. + The position of the new tabbed group relative to the baseItem. + The newly created group. + + + + Inserts the specified tabbed group at a position relative to an item within the root group. + + The group to add to the root group. + A descendant (owned by the root group) next to which the ‘newTabbedGroup’ is inserted. + The position of the new tabbed group relative to the baseItem. + The added group. + + + + Inserts the specified tabbed group to the root group. + + The group to add to the root group. + The added group. + + + + Gets or sets whether users can change the layout. + + true if users can activate customization mode at runtime; otherwise, false. + + + + Gets or sets a default value for the property. The default value is true. + + true if users can customize the layout; otherwise, false. + + + + Gets or sets whether the customization menu can be invoked by end-users. + + true, to allow end-users to invoke the customization menu; otherwise, false. + + + + Gets or sets whether the allows touch gestures. + + true, to enable touch gestures; otherwise, false. + + + + Provides access to the properties that control the appearance of the controls located within the layout control. + + A object which provides the appearance settings for the layout controls. + + + + Gets an object that calculates appearances for layout items based on the appearance settings of items and their parent layout groups. + + An DevExpress.XtraLayout.Helpers.AppearanceController object. + + + + Assigns the unique names to the items contained within the LayoutControl.Items collection. + + + + + Gets or sets whether the layout control will allow an end-user to scroll to any controls placed outside of its visible boundaries. + + true to enable the auto-scrolling feature; otherwise, false. + + + + Not supported. + + A structure. + + + + Not supported. + + A structure. + + + + This property is not supported by the class. + + + + + Gets or sets whether the control’s size is automatically calculated based on its content. + + true if the control’s size is automatically calculated; otherwise, false. + + + + Gets or sets how the control is resized when automatic resizing is enabled. + + A value that specifies how the control is automatically resized. + + + + Gets or sets the control’s background color. + + A that represents the control’s background color. + + + + Gets or sets the layout control’s background image. + + A descendant that represents the layout control’s background image. + + + + Gets or sets the background image layout as defined in the ImageLayout enumeration. + + A value. + + + + Occurs before a layout is restored from storage (a stream, xml file or the system registry). + + + + + Starts the layout control’s runtime initialization. + + + + + Locks the object by preventing visual updates of the object and its elements until the EndUpdate method is called. + + + + + Proportionally resizes layout items that are displayed in a row or column. + + + + + Gets or sets the for the control. + + A for the control. + + + + Returns information on the layout elements located at the specified point. + + A structure which specifies the test point coordinates relative to the layout controls top-left corner. + A object which contains information about the layout elements located at the test point. + + + + Gets or sets a collection of images that can be displayed within layout group captions. + + An object which represents the image source. + + + + Fires when a property of the layout control is changed. + + + + + Fires when a property of the layout control is about to be changed. + + + + + Disposes all the layout items and their controls owned by the Layout Control. Hidden items are not removed. + + + + + Clears items, allowing hidden items to be removed. + + true to clear the LayoutControl.HiddenItems collection; otherwise, false. + true to dispose of controls associated with layout items; otherwise, false. + + + + Gets the layout control’s client height. + + An integer value that specifies the layout control’s client height. + + + + Gets the layout control’s client width. + + An integer value that specifies the layout control’s client width. + + + + Gets the constraints manager. + + A DevExpress.XtraLayout.ConstraintsManager object. + + + + Creates and returns a new Customization Form. + + A DevExpress.XtraLayout.Customization.UserCustomizationForm object which represents the created Customization Form. + + + + Creates an Empty Space Items within the specified group. + + A object which specifies the parent group for the created item. + An object that has been created. + + + + Creates a new Layout Groups within the specified group. + + A object which specifies the parent group for the created group. + A object which represents the newly created group. + + + + Creates a new Layout Item within the specified group. + + A object which specifies the parent group for the created item. + A object which represents the newly created item. + + + + Creates a within the specified group. + + A object which represents the parent group for the created item. + A object that has been created. + + + + Creates a new Tabbed Group within the specified group. + + A object which specifies the parent group for the created group. + A object which represents the newly created tabbed group. + + + + Gets or sets the cursor that is displayed when the mouse pointer is over the control. + + A object. + + + + Allows you to custom paint individual items in the LayoutControl. + + + + + Provides access to the Customization Form. + + A DevExpress.XtraLayout.Customization.UserCustomizationForm object which represents the Customization Form. + + + + Gets or sets the boundaries of the Customization Form. + + A structure which represents the Customization Form’s boundaries. + + + + An object which provides the Context Menu. + + A DevExpress.XtraLayout.Customization.RightButtonMenuManager object. + + + + Gets or sets whether users customize the layout in default mode via context menus or in quick mode via the customization form. + + The customization mode used to adjust the layout by end-users. + + + + Fires after the default layout (the layout saved by the LayoutControl.SetDefaultLayout method) has been loaded. + + + + + Fires before loading the default layout (the layout saved by the LayoutControl.SetDefaultLayout method). + + + + + Gets an object that calculates the enabled states for layout items based on the enabled states of layout groups and controls. + + An DevExpress.XtraLayout.Helpers.EnabledStateController object. + + + + Ends the layout control’s runtime initialization. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Exports the contents of the to the specified stream in XML format. + + A object which specifies the stream to which the is exported in XML format. + + + + Exports the control’s data to a stream in CSV format with the specified options. + + A stream to which the control is exported. + The export options. + + + + Exports the control’s data to the specified stream in CSV format. + + A stream to which the control is exported. + + + + Exports the control’s data to the specified file in CSV format with the specified options. + + The full path to the CSV file. + The export options. + + + + Exports the control’s data to the specified file in CSV format. + + The full path to the CSV file. + + + + Exports the control’s data in the Office Open XML file format (DOCX file) and sends it to the specified stream. + + A System.IO.Stream object to which the created document should be exported. + + + + Exports the control’s data in the Office Open XML file format and saves it to the specified DOCX file. + + A System.String value which specifies the full path (including the file name and extension) where the DOCX file should be created. + + + + Exports the control’s data to the specified stream in HTML format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in HTML format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A object, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a stream in HTML format + + A object, to which the created document is exported. + + + + Exports the control’s data to the specified file in HTML format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a file in HTML format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A that specifies the full path to the file, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the HTML code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a file in HTML format using the specified character encoding. + + A that specifies the full path to the file, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + + + + Exports the controls displayed within the LayoutControl to a file in HTML format + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the control’s data to the specified stream in MHT format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A object, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the control’s data to the specified file in MHT format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A that specifies the full path to the file, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a file in MHT format using the specified character encoding. + + A that specifies the full path to the file, to which the created document is exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + + + + Exports the controls displayed within the LayoutControl to a file in MHT format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in PDF format. + + A object, to which the created document is exported. + + + + Exports the controls displayed within the LayoutControl to a file in PDF format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in RTF format. + + A object, to which the created document is exported. + + + + Exports the controls displayed within the LayoutControl to a file in RTF format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the control’s data to the specified stream in Text format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in TXT format using the specified separator string, quotation and text encoding settings. + + A object, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + true to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, false. + A class descendant specifying the encoding of the created text document. + + + + Exports the controls displayed within the LayoutControl to a stream in TXT format using the specified separator string and quotation settings. + + A object, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + true to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a stream in TXT format using the specified separator string. + + A object, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + + + + Exports the controls displayed within the LayoutControl to a stream in TXT format. + + A object, to which the created document is exported. + + + + Exports the control’s data to the specified file in Text format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a file in TXT format using the specified separator string, quotation and text encoding settings. + + A that specifies the full path to the file, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + true to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, false. + A class descendant specifying the encoding of the created text document. + + + + Exports the controls displayed within the LayoutControl to a file in TXT format using the specified separator string and quotation settings. + + A that specifies the full path to the file, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + true to quote (place quotation marks around) text elements that contain symbols which coincide with the specified separator string; otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a file in TXT format using the specified separator string. + + A that specifies the full path to the file, to which the created document is exported. + A containing symbols which will be used to separate the document’s text elements in the created text file. + + + + Exports the controls displayed within the LayoutControl to a file in TXT format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the control’s data to the specified stream in XLS format using the specified options. + + A object, to which the created document is exported. + A object which specifies the XLS export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a stream in XLS format using the specified formatting settings. + + A object, to which the created document is exported. + true to use the data format of the exported controls for the cells in the XLS document; otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a stream in XLS format. + + A object, to which the created document is exported. + + + + Exports the control’s data to the specified file in XLS format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the XLS export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a file in XLS format using the specified formatting settings. + + A that specifies the full path to the file, to which the created document is exported. + true to use the data format of the exported controls for the cells in the XLS document; otherwise, false. + + + + Exports the controls displayed within the LayoutControl to a file in XLS format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports data to the specified stream in XLSX (MS Excel 2007) format using the specified options. + + A object to which data is exported. + An object that contains export options. + + + + Exports the controls displayed within the LayoutControl to a stream in XLSX (MS Excel 2007) format. + + A object, to which the created document is exported. + + + + Exports the control’s data to the specified file in XLSX (MS Excel 2007) format using the specified options. + + A which specifies the name (including the full path) of the file to which the data is exported. + An object which specifies the XLS export options to be applied when the control is exported. + + + + Exports the controls displayed within the LayoutControl to a file in XLSX (MS Excel 2007) format. + + A that specifies the full path to the file, to which the created document is exported. + + + + For internal use. + + + + + Returns the control with the specified name, contained within the Layout Control. + + A value that specifies the control’s name. + A descendant that represents the control with the specified name, contained within the Layout Control. null (Nothing in Visual Basic) if the control isn’t found. + + + + Gets the specified control’s name. + + A Control object whose name is to be retrieved. + A string that specifies the control’s name. + + + + Returns the group which is located at the specified point. + + A structure which specifies the test point coordinates relative to the layout control’s top-left corner. + A object which represents the group located at the specified point. null (Nothing in Visual Basic) if there is no group at the specified point. + + + + Returns the layout item which is contained within the specified group and holds the specified control. + + A object which represents the control whose parent layout item is to be returned. + A object representing the group within which the search is performed. + A object which contains the specified control. null (Nothing in Visual Basic) if there is no layout item within the specified group which holds the specified control. + + + + Returns the layout item contained within the root group which holds the specified control. + + A object which represents the control whose parent layout item is to be returned. + A object which contains the specified control. null (Nothing in Visual Basic) if there is no layout item within the root group which holds the specified control. + + + + Returns the layout item contained in the specified group and holds the control with the specified repository item. + + A object that represents the repository item of the control whose parent layout item is to be returned. + A object that represents the group in which the search is performed. + A object that contains the control with the specified repository item. null (Nothing in Visual Basic) if there is no layout item in the specified group which holds the control with the specified repository item. + + + + Retrieves the size of a rectangular area into which the control can be fit. + + The custom-sized area for the control. + A System.Drawing.Size value. + + + + Fires after a layout group has been expanded/collapsed. + + + + + Fires when a layout group is about to be expanded or collapsed. + + + + + Recalculates the view information and immediately updates the LayoutControl. + + + + + Provides access to a collection of hidden layout items. + + A DevExpress.XtraLayout.HiddenItemsCollection object which represents a collection of hidden layout items. + + + + Allows you to specify a comparer object for sorting hidden items within the Customization Form. + + An object implementing the interface, which is used to sort hidden items; null if no object has been assigned. + + + + Fires before the Customization Form is closed. + + + + + Closes the Customization Form. + + + + + Hides the specified layout item. + + A descendant which represents the layout item to hide. + + + + Hides the currently selected items to the Customization Form. + + + + + Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag. + + An or that contains images. + + + + Occurs each time a user clicks hyperlinks within captions of layout items and layout groups. + + + + + Gets or sets a collection of icons that can be displayed in a layout item, group, or tab’s label. + + A collection of icons that can be displayed in a layout item, group, or tab’s label. + + + + Indicates whether the LayoutControl has been initialized. + + true if the LayoutControl has been initialized; otherwise, false. + + + + Gets whether the layout has been modified. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + true if the layout has been modified; otherwise, false. + + + + Gets whether the layout has been changed. + + true if the layout has been changed; otherwise, false. + + + + Indicates whether the can be printed. + + true if the LayoutControl can be printed; otherwise, false. + + + + Gets whether the layout control has been locked for updating. + + true if the layout control is locked; otherwise, false; + + + + Fires after a layout item has been added to the Items collection of its parent. + + + + + Fires repeatedly when a layout item is being dragged and allows you to prevent the item from being dropped at a specific position. + + + + + Fires after a layout item has been removed from the Items collection of its parent. + + + + + Provides access to all the layout items owned by the LayoutControl. + + A DevExpress.XtraLayout.Utils.ReadOnlyItemCollection object which represents the collection of layout items. + + + + Fires after the selected layout item has been changed. + + + + + Updates the Layout Control. + + + + + Occurs when the Layout Tree View Context Menu is about to be displayed. + + + + + Occurs after the size of any layout item has been changed. + + + + + Occurs when a layout is restored from a data store (a stream, xml file or system registry), and its version differs from the version of the current layout. + + + + + Gets or sets the version of the layout. + + A string representing the version of the layout. + + + + Provides access to the settings that control the layout control’s look and feel. + + A object whose properties specify the layout control’s look and feel. + + + + Gets or sets an object that controls the look and feel of the popup menus. + + An object that controls the look and feel of the popup menus. + + + + Provides access to the options which control the appearance and behavior of the Customization Form. + + A object which provides options related to the Customization Form. + + + + Provides access to the layout control’s focus options. + + A object that contains the layout control’s focus options. + + + + Provides access to the default alignment settings of the controls displayed in the LayoutControl. + + An object that provides the alignment options. + + + + The Layout Control’s print/export options. This object’s settings affect all layout items and groups. + + The LayoutControl’s print and export options. + + + + Contains options that specify how the LayoutControl’s layout is saved to and restored from a data store (an XML file, a stream or the system registry). + + A object. + + + + Provides access to the display options of the . + + A object which specify the control’s display options. + + + + Provides access to the paint style collection. + + A DevExpress.XtraLayout.Registrator.LayoutPaintStyleCollection object which represents the paint style collection. + + + + Occurs when the Context Menu is about to be displayed. + + + + + Prints the . + + + + + Updates the layout control. + + + + + Registers the specified wrapper object that identifies which properties to display for specific layout items in the Customization Form‘s Property Grid. + + The type of layout item with which the current wrapper object is associated. + The type of the wrapper object to be registered. + + + + Registers the specified ‘fixed’ item for runtime use in the LayoutControl. + + The type of the ‘fixed’ item to be registered. + + + + Registers the specified custom Customization Form. + + The type of the custom Customization Form. + + + + Removes the specified item from the control. + + The object that should be removed. + true, to release all resources; otherwise false. + + + + Removes the specified item from the control. + + The object that should be removed. + + + + Activates an edit box that allows an end-user to rename the currently selected layout item. + + + + + Allows you to provide unique names for layout items created in code, whose names conflict with existing names. + + + + + Restores the layout that has been saved using the LayoutControl.SetDefaultLayout method. + + + + + Restores the layout that is stored at the specified system registry path. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A value that specifies the system registry path. If the specified path doesn’t exist, this method does nothing. + + + + Restores the layout from the specified stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A descendant from which the layout is read. If null (Nothing in Visual Basic), an exception is raised. + + + + Restores the layout from the specified XML file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A value which specifies the path to the XML file that contains the layout to be loaded. If the specified file doesn’t exist, an exception is raised. + + + + Gets or sets the LayoutControl’s root group. + + A object which represents the root group. + + + + Saves the current layout to the specified system registry path. + + A value that specifies the system registry path to which to save the layout. + + + + Saves the current layout to the specified stream. + + A descendant to which the current layout is written. + + + + Saves the layout to an XML file. + + A value that specifies the path to the file where the layout should be stored. If an empty string is specified, an exception is raised. + + + + Selects the currently selected item’s parent. + + + + + Sets the current cursor. + + A object which represents the mouse cursor. + + + + Saves the current layout to an internal memory buffer. + + + + + Occurs when the Context Menu is about to be displayed. + + + + + Fires immediately after the Customization Form has been invoked. + + + + + Invokes the Customization Form. + + + + + Occurs when the Layout Tree View Context Menu is about to be displayed. + + + + + Opens the Print Preview window for the with a Bars UI. + + + + + Displays the Print Preview window with a Ribbon UI. + + + + + Gets or sets the style controller component that provides appearance settings for the control. + + An object which implements the DevExpress.XtraEditors.IStyleController interface and provides appearance settings for the control. + + + + Fires when a Close button within a tab page is clicked. + + + + + Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for layout items. + + The component controlling the appearance and behavior of hints displayed for layout items. + + + + Gets the manager that handles undo/redo operations via the Customization Form. + + A DevExpress.XtraLayout.Customization.UndoManager object. + + + + Allows you to provide unique names for layout items created in code, whose names conflict with existing names. + + + + + Unregisters the specified wrapper object that has been registered via the LayoutControl.RegisterCustomPropertyGridWrapper method. + + The type of the wrapper object to be unregistered. + + + + Unregisters the specified ‘fixed’ item in the current LayoutControl. + + The type of the ‘fixed’ item to be unregistered. + + + + Gets or sets whether controls within the current LayoutControl use the local BindingContext, or the form’s BindingContext. + + true if controls use the LayoutControl’s BindingContext; false if controls use the form’s BindingContext. + + + + A regular group with or without a header and borders. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified parent layout group. + + A descendant which represents the parent layout group. + + + + Creates a new group and adds it to the current group. + + The newly created group. + + + + Creates a new layout group at a position relative to an item within the current group. + + The item (owned by the current group) next to which the new group is inserted. + The position of the new group relative to the baseItem. + The new layout group. + + + + Inserts the specified layout group at a position relative to an item within the current group. + + The layout group to add to the current group. + The item (owned by the current group) next to which the ‘newGroup’ is inserted. + The position of the new group relative to the baseItem. + The added layout group. + + + + Inserts the specified group to the current group. + + The group to add to the current group. + The added group. + + + + Creates a new group with the specified caption at a position relative to an item within the current group. + + A value that specifies the group’s caption. This value is assigned to the BaseLayoutItem.Text property. + A descendant (owned by the current group) next to which a new group is inserted. + The position of the new group relative to the baseItem. + The newly created layout group. + + + + Creates a new group with a specified caption and adds it to the current group. + + The group’s caption. This value is used to initialize the BaseLayoutItem.Text property. + The newly created layout group. + + + + Creates a new layout item with the default layout type and adds it to the current group. + + The newly created item. + + + + Inserts the specified item at a position relative to another item within the current group. + + The item to be moved to a new position. + A descendant (owned by the current group) next to which the ‘newItem’ is inserted. + The position of the new item relative to the baseItem. + The added layout item. + + + + Creates a new layout item at a position relative to an item within the current group. + + A descendant (owned by the current group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Inserts the specified layout item to the current group. + + The layout item to add to the current group. + The added layout item. + + + + Creates a new layout item with the specified text and control at a position relative to another item within the current group. + + A value that specifies the new layout item’s text. + The control to display in the new layout item. This value is used to initialize the LayoutControlItem.Control property. + A descendant (owned by the current group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Creates a new layout item with the specified text and control, and adds it to the current group. + + A value that specifies the layout item’s text. + The control to display in the layout item. This value is used to initialize the LayoutControlItem.Control property. + The newly created item. + + + + Creates a new layout item with the specified text and adds it to the current group. + + A value that specifies the layout item’s text. + The newly created item. + + + + Adds an array of layout items to the current group. + + An array of objects. + + + + Creates a new tabbed group and adds it to the current group. + + The newly created group. + + + + Creates a new tabbed group at a position relative to an item within the current group. + + A descendant (owned by the current group) next to which a new group is inserted. + The position of the new tabbed group relative to the baseItem. + The newly created group. + + + + Inserts the specified tabbed group at a position relative to an item within the current group. + + The group that is to be moved to a new position. + A descendant (owned by the current group) next to which the ‘newTabbedGroup’ is inserted. + The position of the new tabbed group relative to the baseItem. + The added tabbed group. + + + + Inserts the specified tabbed group to the current group. + + The tabbed group to add to the current group. + The added tabbed group. + + + + Hides the group. + + + + + Provides access to the visible layout items owned by the current group. + + A object which represents the collection of visible layout items. + + + + Gets or set the LayoutControl that owns the current layout group. + + A control. + + + + Gets the object which contains information used to render the layout group. + + A DevExpress.XtraLayout.ViewInfo.LayoutControlGroupViewInfo object. + + + + A layout item. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class. + + A object which owns the created layout item. This value is assigned to the BaseLayoutItem.Owner property. + A descendant which is owned by the created layout item. This value is assigned to the LayoutControlItem.Control property. + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets whether the auto-alignment feature is enabled for the item. + + A Boolean value. + + + + Gets or sets whether a label’s icon is filled with the label’s foreground color. + + to use the parent group’s option; to fill the icon with the label’s foreground color; to display the icon as it is. + + + + Gets or sets whether the layout item’s borders are highlighted when the mouse cursor hovers over it. + + true if the layout item can be hot-tracked; otherwise, false. + + + + Gets or sets whether HTML formatting is allowed in the text that is associated with the layout item. + + true if HTML formatting is allowed; otherwise, false. + + + + Gets appearance settings used to paint the caption of a layout item when the item is disabled. + + An object with appearance settings. + + + + Assigns the specified object’s property values to the current object’s corresponding properties. + + The object whose property values to assign to the current object’s corresponding properties. + + + + Gets or sets the horizontal alignment of a control inside this layout item. This property is in effect when the control’s maximum width is limited, and is less than the layout item currently provides. + + The horizontal control alignment. + + + + Gets or sets the vertical alignment of a control inside this layout item. This property is in effect when the control’s maximum height is limited, and is less than the layout item currently provides. + + The horizontal control alignment. + + + + Gets or sets whether the layout item’s contents are visible. + + true if the layout item’s contents are visible; otherwise, false. + + + + Gets or sets the control which is owned by the layout item. + + A descendant which is owned by the layout item. + + + + Gets or sets the alignment of the ‘s control within the layout item. This setting is not intended to be used for version 19.2 and newer. + + A value that specifies the control’s alignment within the layout item. + + + + Gets or sets the client area’s maximum size. + + A structure that defines the client area’s maximum width and height. + + + + Gets or sets the control’s minimum size. + + A structure that defines the control’s minimum width and height. + + + + This property is for internal use only. It is used in serialization. Do not change it. + + A value that specifies the name of the control which is owned by the current layout item. + + + + Gets or sets whether the layout item and its control are enabled. + + true if the layout item and its control are enabled; otherwise, false. + + + + Finishes the component’s initialization. + + + + + Not supported. + + Always True. + + + + Gets or sets whether the control occupies the layout item’s maximum allowed client area. This setting is not intended to be used for version 19.2 and newer. + + true, if the control occupies the layout item’s maximum allowed client area; otheriwse, false. + + + + Gets or sets whether the current layout item is highlighted according to the current skin when focused. + + True if the current layout item is highlighted according to the current skin when focused; False if not; Default use the OptionsView.HighlightFocusedItem global setting. + + + + Gets or sets the icon displayed in the item’s label. + + An object that specifies an image. + + + + Gets or sets the alignment of the icon in the label. + + A enumeration value that specifies the alignment of the icon in the label. + + + + Gets or sets the index of the icon displayed in the item’s label. + + An integer value that specifies the index of an icon in an image collection. + + + + Gets options that allow you to display an icon in the item’s label. + + A object that specifies an icon displayed in the item’s label. + + + + Gets a collection of icons that can be displayed in the item’s label. + + An object that specifies an image collection. + + + + Gets or sets the distance between the label’s text and icon. + + An integer value that specifies the distance between the label’s text and icon, in pixels. + + + + Gets a collection of icons that can be displayed in the item’s label. + + An object that contains images. + + + + Gets or sets the layout item’s maximum size. + + A structure that defines the item’s maximum width and height. + + + + Gets or sets the item’s minimum size. + + A structure that defines the item’s minimum width and height. + + + + The item’s print/export options. + + The layout item’s print and export options. + + + + Gets or set the LayoutControl that owns the current layout item. + + A LayoutControl control. + + + + Gets or sets the size constraints type. + + A enumeration value which specifies the manner in which the current layout item can be resized. + + + + Gets or sets the vector image for this item’s label. + + An object that specifies a vector image. + + + + Gets or sets the size of vector image for this item’s label. + + A structure that specifies an image size. + + + + Gets or sets the alignment settings of the item’s control. + + A value. + + + + Gets or sets whether the client region’s height is trimmed to match the control’s height. This setting is not intended to be used for version 19.2 and newer. + + true if the client region’s height is trimmed to match the control’s height; otherwise, false. + + + + Gets the name of the item’s type. + + The “LayoutControlItem” string. + + + + Gets the object which contains information used to render the layout item. + + A DevExpress.XtraLayout.ViewInfo.LayoutControlItemViewInfo object. + + + + Contains options that specify the icon in a layout item’s label. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets how the alignment of the icon in the item’s label. + + A value that specifies the alignment of the icon in the item’s label. + + + + Gets or sets whether the icon is filled with the control’s foreground color. + + to use the parent group’s option; to fill the icon with the control’s foreground color; to display the icon as it is. + + + + Gets or sets the amount of space between the icon and the text in the label. + + An integer value that specifies the amount of space between the icon and the text in the label. + + + + A base class for regular layout groups. + + + + + Invokes the Visit method of the specified visitor for each layout item that belongs to the current layout item group. + + A DevExpress.XtraLayout.Utils.BaseVisitor class descendant. + + + + Adds the specified item along the bottom or right edge of the current group. + + The item to be added to the current group. + + + + Creates a new group and adds it to the current group. + + The newly added group. + + + + Creates a new group at a position relative to an item within the current group. + + A descendant (owned by the current group) next to which a new group is inserted. + The position of the new group relative to the baseItem. + The newly created layout group. + + + + Inserts the specified group at a position relative to an item within the current group. + + The group to be moved to a new position. + A descendant (owned by the current group) next to which the ‘newGroup’ is inserted. + The position of the new group relative to the baseItem. + The added group. + + + + Inserts the specified group to the current group. + + The group to add to the current group. + The added layout group. + + + + Creates a new group with the specified caption at a position relative to an item within the current group. + + A value that specifies the group’s caption. This value is assigned to the BaseLayoutItem.Text property. + A descendant (owned by the current group) next to which a new group is inserted. + The position of the new group relative to the baseItem. + The newly created layout group. + + + + Creates a new group with the default layout type and the specified caption, and adds it to the current group. + + The group’s caption. This value is used to initialize to the BaseLayoutItem.Text property. + The newly added group. + + + + Creates a new layout item and adds it to the current group. + + The newly added item. + + + + Inserts the specified item at a position relative to another item within the current group. + + The item to be moved to a new position. + A descendant (owned by the current group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The added layout item. + + + + Creates a new layout item at a position relative to an item within the current group. + + A descendant (owned by the current group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Inserts the specified item to the current group. + + A descendant which represents the layout item to add to the collection. + The added layout item. + + + + Inserts the specified item at a position relative to another item within the current group. Allows the new text to be specified for the item. + + A value that specifies the new text to be assigned to the added item. The parameter is ignored if the value represents an empty string. + The item to be moved to a new position. + A descendant (owned by the current group) next to which the ‘newItem’ is inserted. + The position of the new item relative to the baseItem. + The added layout item. + + + + Creates a new layout item with the specified text at a position relative to an item within the current group. + + A value that specifies the new layout item’s text. + A descendant (owned by the current group) next to which a new item is inserted. + The position of the new item relative to the baseItem. + The newly created layout item. + + + + Creates a new layout item with the specified text and adds it to the current group. + + A value that specifies the layout item’s text. + The created layout item. + + + + Creates a new tabbed group and adds it to the current group. + + The created group. + + + + Creates a new tabbed group at a position relative to an item within the current group. + + A descendant (owned by the current group) next to which a new group is inserted. + The position of the new tabbed group relative to the baseItem. + The newly added tabbed group. + + + + Inserts the specified tabbed group at a position relative to an item within the current group. + + The tabbed group to add to the collection. + A descendant (owned by the current group) next to which the ‘newTabbedGroup’ is inserted. + The position of the new tabbed group relative to the baseItem. + The added tabbed group. + + + + Inserts the specified tabbed group to the current group. + + The tabbed group to add to the collection. + The added group. + + + + Gets or sets whether to colorize the layout group border and caption using the LayoutGroup.AppearanceGroup.BorderColor setting in skinning paint schemes. This property is ignored by default starting from v18.2. + + true if the layout group border should be colorized according to its border color in skinning paint schemes; otherwise, false. + + + + Gets or sets whether to paint the group’s background when the LayoutGroup.GroupBordersVisible property is set to false. + + true if the group’s background is painted; otherwise, false. + + + + Gets or sets whether the group or tab’s icon is filled with the control’s foreground color. + + to use the control’s option; to fill the icon with the control’s foreground color; to display the icon as it is. + + + + Gets or sets whether HTML formatting is allowed within the layout group caption. + + true if the HTML formatting is allowed; otherwise, false. + + + + Gets or sets the group’s background image that can be stretched across the group, tiled, centered, etc. + + An object. + + + + Gets or sets the position and behavior of the background image assigned to the LayoutGroup.BackgroundImage property. + + An value. + + + + Provides access to all properties that allow you to assign and customize this group’s background image at the bottom layer. + + A DevExpress.XtraLayout.LayoutGroupBackgroundImageOptions object that comprises properties that allow you to assign and customize this group’s background image at the bottom layer. + + + + Gets or sets whether the background image, specified by the LayoutGroup.BackgroundImage property, is in effect. + + true if the background image, specified by the LayoutGroup.BackgroundImage property, is in effect; otherwise, false. + + + + Resizes all elements with the group so that they are displayed in the optimal way. + + + + + Returns whether the layout mode can be changed for a . + + true if the layout mode can be changed; otherwise, false. + + + + Returns whether a new tabbed group can be created within the current group which will display a selected child group. + + true if a tabbed group can be created; otherwise, false. + + + + Returns whether a new group can be created within the current group which will display selected child items. + + true if a new group can be created; otherwise, false. + + + + Returns whether the specified item can be moved to the specified new position. + + A object that contains information on the item that would be moved and the position that the item would be moved to. + true if the specified item can be moved to the specified new position; otherwise, false. + + + + Specifies the image to display within the group’s caption area. + + A object that specifies the group’s caption image. + + + + Gets or sets the index of an image in the LayoutControl.Images or LayoutView.Images collection that is displayed in the group or tab’s label. + + An integer value that specifies the zero-based index of an image in the LayoutControl.Images or LayoutView.Images collection. + + + + Gets or sets the icon’s alignment relative to the text. + + A enumeration value that specifies the icon’s alignment relative to the text. + + + + Gets options that specify the label’s icon. + + A object that contains image options. + + + + Gets or sets the amount of space between the icon and the label’s bounds. + + A structure that specifies the amount of space between the icon and the label’s bounds. + + + + Gets or sets whether the label’s icon is visible. + + true if the label’s icon is visible; otherwise, false. + + + + Not supported. + + + + + Removes the items from the current group. + + + + + Removes all items from the current group. + + true, to release all resources; otherwise false. + + + + Clears selected items specified by the LayoutGroup.SelectedItems property. + + true if the selection was modified; otherwise, false. + + + + Gets or sets the group’s background image that is displayed “as is”, and can be aligned to any group’s edge. + + An object. + + + + Gets or sets the content image’s alignment within the group. + + A value that specifies the content image’s alignment. + + + + Provides access to all properties that allow you to assign and customize this group’s background image at the top layer. + + A DevExpress.XtraLayout.LayoutGroupContentImageOptions object that comprises properties that allow you to assign and customize this group’s background image at the top layer. + + + + Gets the number of items that the current group owns. + + An integer that specifies the number of items that the current group own. + + + + Creates a new group that will contain the currently selected child items. + + A descendant that specifies the group that has been created. + + + + Creates a new tabbed group that will display the selected child group within the current group. + + A descendant that specifies the group that has been created. + + + + Fires when a custom header button is checked. + + + + + Fires on a regular (push) custom header button click. + + + + + Fires when a custom header button is unchecked. + + + + + Allows you to custom paint the group’s client area background. + + + + + Allows you to custom paint the caption region. + + + + + Allows you to custom paint header buttons (LayoutGroup.CustomHeaderButtons). + + + + + Gets or sets the collection of custom buttons displayed in the group header. + + A collection of buttons displayed in the group header. + + + + Gets or sets the default layout type for newly created items within the current group. + + A object that specifies the default layout type. + + + + Gets or sets whether layout items that belong to the current group are enabled. + + true if layout items that belong to the current group are enabled; otherwise, false. + + + + Gets or sets whether a layout group’s indents, specified by its BaseLayoutItem.Spacing and BaseLayoutItem.Padding properties, are applied when the group’s borders are hidden. + + true if a layout group’s indents are applied when the group’s borders are hidden; otherwise, false. + + + + Gets or sets the position of the expand button within the group header. + + A value that specifies the expand button’s position. + + + + Gets or sets the direction of the expand button’s arrow. + + A value that specifies the direction of the expand button’s arrow. + + + + Gets or sets whether the group’s expand button is visible. + + true if the group’s expand button is visible; otherwise, false. + + + + Gets or sets whether the current group is expanded. + + true if the group is expanded; otherwise, false. + + + + Gets or sets whether the group is expanded/collapsed on double-clicking its caption. + + true if the group is expanded/collapsed on double-clicking its caption; otherwise, false. + + + + Flips the current group’s layout items around a vertical axis. + + + + + Flips the current group’s layout items around a vertical axis, and optionally allows you to flip the items in nested groups, if any. + + true if nested layout groups must be processed as well; otherwise, false. + + + + Gets or sets the direction according to which the arranges its child elements. + + A enumeration value that specifies the direction according to which the arranges its child elements. + + + + Gets the default value of the group’s BaseLayoutItem.Text property. + + A string that specifies the default value of the group’s BaseLayoutItem.Text property. + + + + Gets whether the group’s borders are visible. + + true if the group’s borders are visible; otherwise false. + + + + Gets or sets the border and the header style of this . + + A DevExpress.Utils.GroupStyle enumeration value that specifies the border and the header style of this . + + + + Gets or sets whether the group header buttons are displayed before or after text. + + The position of the group header button relative to the header text. + + + + Gets a collection of images that can be displayed in the group’s label. + + An object that specifies an image collection. + + + + Invalidates the region which is occupied by the Layout Group. + + + + + Gets whether the current group is displayed as a tab within a tabbed group. + + true if the current group is displayed as a tab within a tabbed group; otherwise false. + + + + Provides indexed access to the items that belong to the current group. + + An integer that specifies the index of the required item. + A object that represents the item at the specified index. + + + + Provides access to the collection of items owned by the current group. + + A object that contains the group’s child items. + + + + Gets or sets the layout mode for a . + + A enumerator value that specifies the layout mode for the LayoutGroup. + + + + Gets the maximum size of the group. + + A structure that defines the group’s maximum width and height. + + + + Gets the minimum size of the group. + + A structure that defines the group’s minimum width and height. + + + + Moves the layout group to the specified position within the LayoutControl. + + A object whose settings determine the position to which the layout group should be moved. + true if the layout group has been successfully moved to a new position; otherwise, false. + + + + Gets or sets whether, in Automatic Tab Order mode when TAB is pressed, the focus moves across grouped controls and then down, or first down and then across. + + A DevExpress.XtraLayout.MoveFocusDirectionGroup enumeration value that specifies whether the focus moves across grouped controls and then down, or first down and then across. Default uses the OptionsFocus.MoveFocusDirection setting. + + + + Gets or sets whether, in Automatic Tab Order mode when TAB is pressed, the focus moves across grouped controls from right to left. + + true to move focus from right to left; false to move focus from left to right. Default uses the OptionsFocus.MoveFocusRightToLeft setting. + + + + Gets the options that determine how the controls displayed within the current group are aligned. + + A object. + + + + The group’s print/export options. This object’s settings affect all layout items owned by the group. + + The layout group’s print and export options. + + + + Provides settings and events for table layout customization. + + An object that contains options and settings specific to table layout mode. + + + + Gets or sets whether the tab that corresponds to the current group is enabled. This property is in effect when the group is represented as a tab page within a . + + true if the tab that corresponds to the current group is enabled; otherwise, false. + + + + Gets or sets the group that owns the current group. + + A or its descendant that owns the current group. + + + + Gets the parent tabbed group if the current group is displayed as a tab. + + A descendant that specifies the parent tabbed group; null if the current group is not displayed as a tab within a tabbed group. + + + + Removes the specified child item within the current group. + + The object that should be removed. + + + + Removes the child item at the specified index. + + An integer that specifies the index of the item to remove. + + + + Interchanges the columns and rows of layout items, including columns and rows of nested groups. + + + + + Interchanges the columns and rows of layout items, and optionally allows you to rotate nested groups. + + true if nested layout groups must be rotated as well; otherwise, false. + + + + Provides access to the collection of selected items within the current group. + + A DevExpress.XtraLayout.Utils.BaseItemCollection collection that contains the group’s selected items. + + + + Gets or sets whether a Close button is displayed within a group when it’s embedded into a . + + true if a Close button is visible when a group is embedded into a TabbedGroup; otherwise, false. + + + + Gets or sets the group’s size. + + A structure that defines the group’s width and height. + + + + Gets the name of the group’s parent if the current group is displayed as a tab. + + A string which specifies the parent’s name. + + + + Gets the name of the item’s type. + + The LayoutGroup value. + + + + Ungroups the selected child group. + + + + + Gets the object which contains the information used to render the layout group. + + A DevExpress.XtraLayout.ViewInfo.LayoutGroupViewInfo object. + + + + Contains options that specify the image in a layout group or tab’s label (header). + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets whether the icon is filled with the control’s foreground color. + + to use the owner control’s option; to fill the icon with the control’s foreground color; to display the icon as it is. + + + + Gets or sets the alignment of the icon relative to the text. + + A value that specifies the alignment of the icon relative to the text. + + + + Gets or sets the amount of space between the icon and the label’s bounds. + + A structure that specifies the amount of space between the icon and the label’s bounds. + + + + Gets or sets whether the icon is visible. + + true if the icon is visible; otherwise, false. + + + + Represents the base class for layout items. + + + + + Represets a container of layout items. + + + + + Gets or sets whether the layout of the current container can be customized using drag and drop. + + true if the layout of the current container can be customized using drag and drop; otherwise, false. + + + + Provides access to the properties that control the group’s appearance. + + A object that provides the appearance settings used to paint the group. + + + + Provides access to a tabbed group’s appearance settings. + + A DevExpress.XtraLayout.Helpers.LayoutPageAppearance object that provides the appearance settings for a tabbed group. + + + + Locks the object by preventing visual updates of the object and its elements until the EndUpdate method is called. + + + + + Gets whether the specified item belongs to the current container. + + A object whose membership should be tested. + true if the specified item belongs to the current container; otherwise, false. + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Provides access to the appearance settings currently used to paint the layout group. + + An object that contains the corresponding appearance settings. + + + + Provides access to the appearance settings currently used to paint layout items that belong to the current container. + + An object that contains the corresponding appearance settings. + + + + Gets or sets the layout group that owns the . + + A object that owns the . + + + + Gets or sets the width, in pixels, of tab headers. + + An integer value that specifies the width, in pixels, of tab headers. + + + + Gets or sets the container’s side along which its caption is displayed. + + A value which specifies the container’s side along which its caption is displayed. + + + + Not supported. + + A structure. + + + + Not supported. + + Zero. + + + + Provides data for the LayoutControl.PopupMenuShowing event. + + + + + Initializes a new instance of the class with the specified settings. + + A object representing the menu to be displayed. This object is assigned to the Menu property. + A object that identifies the clicked object. This object is assigned to the HitInfo property. + A Boolean value that specifies whether the menu is allowed to be displayed. This value is assigned to the Allow property. + + + + Initializes a new instance of the class with the specified settings. + + A object representing the menu to be displayed. This object is assigned to the Menu property. + A object that identifies the clicked object. This object is assigned to the HitInfo property. + + + + Represents a method for handling the LayoutControl.PopupMenuShowing event. + + The event source. This identifies the LayoutControl control which fires the event. + A object that contains data for the event. + + + + Represents a layout item capable of displaying information provided by a repository item. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified repository item. + + A object to be associated with the created layout item. This value is assigned to the LayoutRepositoryItem.RepositoryItem property. + + + + This property supports the internal infrastructure, and is not intended to be used directly from your code. + + A string value. + + + + Specifies the desired width of the layout item’s region displaying the editor (repository item). + + An integer value that specifies the width of the layout item’s edit portion. + + + + Gets or sets a value to be displayed by a repository item. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + An object representing the value to be displayed. + + + + Gets or sets a repository item associated with the current layout item. + + A object to be associated with the current layout item. + + + + Resets the desired width of the layout item’s region displaying an editor. + + + + + Gets the name of the item’s type. + + The “LayoutRepositoryItem” string. + + + + Contains options that specify how the LayoutControl’s layout is saved to and restored from a data store (an XML file, a stream or the system registry). + + + + + Initializes a new instance of the class with default settings. + + + + + Copies options from the specified object to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the items that exist in a layout when it’s restored, but that don’t exist in the current layout control, should be discarded or added to the control. + + true to discard the items that exist in the layout being restored, but don’t exist in the current layout control; false to add these items to the layout control. + + + + Gets or sets whether or not secondary layout items should be re-created when restoring the LayoutControl’s layout. + + true if secondary layout items should be re-created; otherwise, false. + + + + Gets or sets whether the appearance settings of item captions are loaded when a layout is loaded from a data store. + + A Boolean value that specifies whether the corresponding appearance options are restored when a layout is restored. + + + + Gets or sets whether the appearance settings of tab pages are loaded when a layout is loaded from a data store. + + A Boolean value that specifies whether the corresponding appearance options are restored when a layout is restored. + + + + Gets or sets whether layout items’ state settings (LayoutGroup.Enabled) are restored when restoring the control’s layout from a data store. + + true, to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout groups’ padding settings (BaseLayoutItem.Padding) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout groups’ spacing settings (BaseLayoutItem.Spacing) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether the appearance settings of groups are loaded when a layout is loaded from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A Boolean value that specifies whether the corresponding appearance options are restored when a layout is restored. + + + + Gets or sets whether values of layout items’ BaseLayoutItem.CustomizationFormText properties are restored when restoring the control’s layout from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout items’ state settings (LayoutControlItem.Enabled) are restored when restoring the control’s layout from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + true, to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout items’ padding settings (BaseLayoutItem.Padding) are restored when restoring the control’s layout from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout items’ spacing settings (BaseLayoutItem.Spacing) are restored when restoring the control’s layout from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether layout items’ captions are restored when restoring the control’s layout from a data store. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + true if layout items’ captions are restored when restoring the control’s layout from a data store; otherwise, false. + + + + Gets or sets whether the layout root group’s padding settings (BaseLayoutItem.Padding) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether the layout root group’s spacing settings (BaseLayoutItem.Spacing) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether tabbed groups’ padding settings (BaseLayoutItem.Padding) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether tabbed groups’ spacing settings (BaseLayoutItem.Spacing) are restored when restoring the control’s layout from a data store. + + true to restore the corresponding settings; otherwise, false. + + + + Gets or sets whether values of the TextToControlDistance properties (BaseLayoutItem.TextToControlDistance and LayoutGroup .OptionsItemText.TextToControlDistance) are restored when you load the control’s layout from a data store. + + true to restore the TextToControlDistance settings; otherwise, false. + + + + Gets or sets whether the control’s appearance settings are stored (restored) when the layout is saved to (loaded from) storage. + + A value that specifies whether to store and restore the control’s appearance settings. + + + + Gets or sets whether “enabled” states of layout items are stored (restored) when the layout is saved to (loaded from) storage. + + A value that specifies whether to store and restore the “enabled” states of layout items. + + + + Gets or sets whether print settings are stored (restored) when the layout is saved to (loaded from) storage. + + A value that specifies whether to store and restore the print settings. + + + + Gets or sets whether padding, margin, and distance settings are stored (restored) when the layout is saved to (loaded from) storage. + + A value that specifies whether to store and restore the distance settings of layout items. + + + + Gets or sets whether captions of layout items and groups are stored (restored) when the layout is saved to (loaded from) storage. + + A value that specifies whether to store and restore the text of layout items and groups. + + + + Contains classes and enumerations that are intended to localize the User Interface of the DevExpress WinForms Layout Manager. + + + + + A base class that provides necessary functionality for custom localizers of the Layout Manager. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets a localizer object providing localization of the user interface at runtime. + + An descendant, used to localize the user interface at runtime. + + + + Returns a localizer object, which provides resources based on the thread’s language and regional settings (culture). + + An object representing resources based on the thread’s culture. + + + + Returns a localizer object, which provides resources based on the thread’s language and regional settings (culture). + + A object, which provides resources based on the thread’s culture. + + + + Returns a localized string for the specified UI element. + + A value that uniquely identifies a UI element. + The localized string. + + + + A default localizer to translate resources for the WinForms Layout Manager. + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies the direction in which focus is moved when the TAB key is pressed. + + + + + Focus moves from one ‘row’ to another selecting each control in a row. + + + + + Focus moves from one ‘column’ to another selecting each control in a column + + + + + Contains options that affect the appearance of the Customization Form. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the default handling of the DELETE key in customization mode is disabled. + + true if the default handling of the DELETE key in customization mode is disabled; otherwise, false. + + + + Gets or sets whether the LayoutControl allows an end-user to undo/redo runtime customization operations. + + true if the LayoutControl allows an end-user to undo/redo runtime customization operations; otherwise, false. + + + + Gets or sets whether the Hidden Items Tab or Layout Tree View Tab is selected by default. + + A DevExpress.XtraLayout.CustomizationPage enumeration value, such as HiddenItems or LayoutTreeView, that specifies whether the Hidden Items Tab or Layout Tree View Tab is selected by default. + + + + Gets or sets the default directory for the Open dialog that is opened when clicking on the Customization Form‘s Load Layout button. + + A string that specifies the default directory for the Open dialog invoked via the Customization Form. + + + + Gets or sets the default directory for the Save dialog that is opened when clicking on the Customization Form‘s Save Layout button. + + A string that specifies the default directory for the Save dialog invoked via the Customization Form. + + + + Gets or sets the coordinates and bounding rectangle of the control’s Customization Form at design time. + + A Nullable Rectangle value that specifies the Customization Form’s coordinates and bounds at design time. + + + + Gets or sets whether the Undo Manager, which allows customization operations to be reverted, is enabled. + + true if the Undo Manager is enabled; otherwise, false. + + + + Returns whether the Property Grid is displayed within the Customization Form. + + true, to display the Property Grid within the Customization Form; otherwise, false. + + + + Gets or sets a delay between pressing the and the start of quick customization mode initialization. + + A value that specifies the delay between pressing the and the start of quick customization mode initialization (displaying the load indicator). + + + + Gets or sets the size of the quick customization mode load indicator. + + A value that specifies the load indicator’s height and width. + + + + Gets or sets quick mode activation time. + + A value that specifies quick mode activation time (load indicator filling time). + + + + Gets or sets whether the Layout Tree View tab page is visible in the Customization Form. + + true if the Layout Tree View tab page is visible; otherwise, false. + + + + Gets or sets whether the Customization Form’s Load button is visible. + + true if the Load button is visible; otherwise, false. + + + + Gets or sets whether the Property Grid is displayed within the Customization Form. + + true to display the Property Grid within the Customization Form; otherwise, false. + + + + Gets or sets whether the Customization Form’s Redo button is visible. + + true if the Redo button is visible; otherwise, false. + + + + Gets or sets whether the Customization Form’s Save button is visible. + + true if the Save button is visible; otherwise, false. + + + + Gets or sets whether the Customization Form’s Undo button is visible. + + true if the Undo button is visible; otherwise, false. + + + + Gets or sets to which objects this Customization Form is allowed to snap. + + A SnapMode enumeration value that specifies to which objects this Customization Form is allowed to snap. + + + + Contains options that affect focus movement between controls within the Layout Control and layout groups. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified focus direction and right-to-left setting. + + A value that specifies how focus is moved when the TAB key is pressed. This value is assigned to the OptionsFocus.MoveFocusDirection property. + A Boolean value that specifies whether focus needs to be moved from right to left when the TAB key is pressed. This value is assigned to the OptionsFocus.MoveFocusRightToLeft property. + + + + Gets or sets whether the currently selected child control is activated when the LayoutControl receives focus. + + true if the currently selected child control is activated when the LayoutControl receives focus; otherwise, false. + + + + Gets or sets whether the first control within a tab page is focused when the tab page is activated. + + true if the first control within a tab page is focused when the tab page is activated; false if focus is not moved to this control. + + + + Gets or sets whether a layout item’s control is focused when its label is clicked. + + true if a layout item’s control is focused when its label is clicked; otherwise, false. + + + + Gets or sets whether the expand buttons of regular groups can be focused when the TAB key is pressed. + + true if the expand buttons of groups can receive focus; otherwise, false. + + + + Gets or sets whether read-only editors are focused when focus is moved between controls using the TAB key. + + true if read-only editors are focused when focus is moved between controls using the TAB key; otherwise, false. + + + + Gets or sets whether the headers of tabbed groups can be focused. + + true if the headers of tabbed groups can be focused; otherwise, false. + + + + Gets or sets whether the Automatic Tab Order feature is enabled. + + true if the Automatic Tab Order feature is enabled; otherwise, false. + + + + Gets or sets the direction in which focus moves in Automatic Tab Order mode when the TAB key is pressed. + + A value that specifies the direction in which focus moves. + + + + Gets or sets whether focus moves from right to left. + + true if focus moves from right to left; false if focus moves from left to right. + + + + Contains default options that specify how the text regions of layout items displayed within the LayoutControl are rendered. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether controls with hidden text must be aligned when the control horizontal alignment is enabled. + + true if controls with hidden text must be aligned when the control horizontal alignment is enabled; otherwise, false. + + + + Specifies the alignment options. + + + + + Releases all resources used by the current object. + + + + + Gets or sets whether the automatic alignment of controls is enabled. + + + + + Gets or sets the alignment settings of the controls which are displayed in the LayoutControl. + + A value which specifies the current alignment mode. + + + + Gets options that specify how text is rendered. + + A object. + + + + Gets or sets the default distance between the text regions of layout items and the corresponding controls. + + An integer value that represents the distance between the text regions of layout items and the corresponding controls. + + + + Contains options that specify how the text regions of layout items, displayed within a specific group, are rendered. + + + + + Initializes a new instance of the class with default settings. + + A object which will own the new object. + + + + Gets or sets whether controls with hidden text must be aligned when the local horizontal alignment of controls within the group is enabled. + + true if controls with hidden text must be aligned when the local horizontal alignment is enabled; otherwise, false. + + + + Disposes of the current object. + + + + + Gets or sets the alignment settings of the controls displayed in the current group. + + A value which specifies the alignment settings of the controls. + + + + Gets or sets the distance between text regions and controls for the current group’s layout items. + + The distance between text regions and controls in the current group. + + + + Returns a string representing the current object. + + A String value that represents the current object. + + + + The base class for classes that provide print and export options for layout items and groups. + + + + + Initializes a new instance of an class with the specified owner. + + An object that will own the created object. + + + + Gets or sets whether a layout item along with its nested items are included in a ‘s print/export output . + + true, if the layout item and its nested items are printed/exported; false, if they are excluded from the printing/export output. + + + + Print/export appearance settings of a specific item’s label and control. For a Layout Group, this property specifies the default appearance settings for all layout items owned by the group. + + The print appearance settings applied to the item’s label and control. + + + + Contains print/export appearance settings used to paint a layout item. + + Print/export appearance settings used to paint the current layout item. + + + + Print/export appearance settings of a specific item’s control. For a Layout Group, this property specifies the default appearance settings for controls of all layout items owned by the group. + + The print appearance settings applied to the item’s control. + + + + Print/export appearance settings of a specific item’s label. For a Layout Group, this property specifies the default appearance settings for labels of all layout items owned by the group. + + The print appearance settings applied to the item’s label. + + + + Gets or sets the distance between a layout item’s text and its control in the LayoutControl’s print/export output. + + A value that specifies the distance between the text region and control, in pixels. + + + + Provides the Layout Control’s print and export options. + + + + + Initializes a new instance of an class with the specified owner. + + + + + Gets or sets whether the , when printed, is horizontally stretched to the width of the printing page. + + true if the LayoutControl is fit to the page width; otherwise, false. + + + + The default print/export appearance settings used to paint captions of layout groups. + + An object that contains settings to customize the appearance of layout group captions. + + + + The default print/export appearance settings applied to labels and controls for all layout items. + + The default appearance settings applied to labels and controls for all layout items. + + + + Contains print/export appearance settings used to paint layout items. + + Print/export appearance settings used to paint layout items. + + + + The default print/export appearance settings applied to controls for all layout items. + + The default appearance settings applied to controls for all layout items. + + + + The default print/export appearance settings applied to labels for all layout items. + + The default appearance settings applied to labels for all layout items. + + + + Disposes of the current object. + + + + + Gets or sets whether a utilizes the old print/export mode. + + true, if the LayoutControl uses the old print/export mode; false, if it uses the default mode. + + + + Gets or sets the distance between text regions of all layout items and their controls in a ‘s print/export output. + + A value that specifies the distance between text regions and controls, in pixels. + + + + A layout group’s print and export options. + + + + + Initializes a new instance of an class with the specified owner. + + An object that will own the created object. + + + + Gets or sets whether the layout group’s caption is included in the print/export output . + + true, if the layout group’s caption is printed/exported; false, if the group’s caption is excluded from the print/export output. + + + + Print/export appearance settings used to paint a layout group’s caption. + + An object that contains settings to customize the appearance of the layout group’s caption. + + + + A layout item’s print and export options. + + + + + Initializes a new instance of the class with specified settings. + + + + + Provides options and methods to customize a table layout enabled for a . + + + + + Initializes a new instance of an class with the specified owners. + + An object that implements the ILayoutControl interface, and owns the created object. + A layout group that owns the created object. + + + + Adds the specified column to a table layout. + + An object that specifies the column to be added. + + + + Adds the specified row to a table layout. + + An object that specifies the row to be added. + + + + Creates a new column with default settings and adds it to the table layout. + + An object that specifies the newly created column. + + + + Creates a new row with default settings and adds it to the table layout. + + An object that specifies the new row. + + + + Gets or sets the default size for empty rows/columns of the SizeType.AutoSize type in table layout mode. + + A value that specifies the size for rows/columns of the AutoSize type, in pixels. + + + + Returns the number of columns within the table layout. + + The number of columns within the table layout. + + + + Provides access to columns of the table layout. + + The table layout’s columns. + + + + Returns a column by its index within the table layout. + + The column’s zero-based index. + The column located at the specified position within the column collection. + + + + Returns a row by its index within the table layout. + + The row’s zero-based index. + The row located at the specified position within the row collection. + + + + Inserts an element into the collection at the specified index. + + The zero-based index at which a columnDefinition should be inserted. + The to insert. + true, to recalculate the OptionsTableLayoutItem.ColumnIndex property of items in the current layout group; otherwise, false. + + + + Inserts an element into the collection at the specified index. + + The zero-based index at which a rowDefinition should be inserted. + The to insert. + true, to recalculate the OptionsTableLayoutItem.RowIndex property of items in the current layout group; otherwise, false. + + + + Removes the specified column definition. + + The to remove. + true, to recalculate the OptionsTableLayoutItem.ColumnIndex property of items in the current layout group; otherwise, false. + + + + Removes the specified row definition. + + The to remove. + true, to recalculate the OptionsTableLayoutItem.RowIndex property of items in the current layout group; otherwise, false. + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + true, to recalculate the OptionsTableLayoutItem.ColumnIndex property of items in the current layout group; otherwise, false. + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + true, to recalculate the OptionsTableLayoutItem.RowIndex property of items in the current layout group; otherwise, false. + + + + Returns the number of rows within the table layout. + + The number of rows within the table layout. + + + + Provides access to rows of the table layout. + + The table layout’s rows. + + + + Gets or sets whether to automatically minimize empty rows/columns whose SizeType property is set to AutoSize. + + A value that specifies if the LayoutControl minimizes empty rows/columns whose SizeType property is set to AutoSize. + + + + Provides settings that specify the item’s position in a table layout. + + + + + Initializes a new instance of an class with the specified owner. + + A layout item that owns the created object. + + + + Assigns the specified object’s property values to the current object’s corresponding properties. + + The object whose property values to assign to the current object’s corresponding properties. + + + + Gets or sets the index of the column in which the current layout item is displayed. + + The zero-based index that specifies the layout item’s column position within the table layout. + + + + Gets or sets the number of columns spanned by the current layout item within the table layout. + + A positive integer value that specifies the number of columns spanned by the layout item. + + + + Gets or sets the index of the row in which the current layout item is displayed. + + The zero-based index that specifies the layout item’s row position within the table layout. + + + + Gets or sets the number of rows spanned by the current layout item within the table layout. + + A positive integer value that specifies the number of rows spanned by the layout item. + + + + Contains options that determine the control’s display options + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether layout groups are collapsed/expanded using animation. + + True, if layout groups are collapsed/expanded using animation; False if not. Default uses the WindowsFormsSettings.AnimationMode global setting. + + + + Gets or sets whether icons for all layout items within the current should be painted in the items’ foreground colors. + + true if icons for all layout items within the current should be painted in the items’ foreground colors; otherwise, false. + + + + Gets or sets whether layout item borders are highlighted when the mouse cursor hovers over the layout items. + + true if the hot-tracking of layout items is enabled; otherwise, false. + + + + This option is equivalent to the OptionsView.AllowItemSkinning option. + + A Boolean value. + + + + Gets or sets whether the OptionsView.DrawItemBorders, OptionsView.HighlightDisabledItem and OptionsView.HighlightFocusedItem options are in effect. + + True, if the corresponding options are in effect; otherwise; False. + + + + Gets or sets whether or not lock size indicators should be displayed during the runtime customization. + + A enumerator value that specifies whether or not lock size indicators should be displayed during the runtime customization. + + + + This property is now obsolete. Use the OptionsView.UseParentAutoScaleFactor property instead. + + + + + Allows the parent’s background to be seen through the LayoutControl. + + A Boolean value. + + + + Gets or sets whether focusing a control that is out of view automatically scrolls the LayoutControl to make this control visible. + + true if focusing a control that is out of view automatically scrolls the LayoutControl to make this control visible; otherwise, false. + + + + Gets or sets how a LayoutControl’s size is changed when it is positioned within another LayoutControl. + + A value that specifies how the LayoutControl’s size is changed when it is positioned within another LayoutControl. + + + + Gets or sets how a LayoutControl’s size is changed when it’s positioned within another LayoutControl. + + A value. + + + + Gets or sets how default maximum size constraints are calculated for controls that implement the interface. + + A value. + + + + Gets or sets how default minimum size constraints are calculated for controls that implement the interface. + + A value. + + + + Gets or sets the number of frames in the fade animation. + + An integer value that specifies the number of frames in the fade animation. + + + + Gets or sets the fade animation length. + + An integer value that specifies the length of the fade animation, in miliseconds. + + + + Gets or sets whether to draw an adorner layer that is used to provide customization visual cues. + + A value that specifies whether to draw the adorner layer. + + + + Gets or sets whether to draw an adorner layer used to provide customization visual cues. + + A value that specifies whether to draw the adorner layer. + + + + Gets or sets whether layout item borders are visible at runtime. + + true if item borders are visible at runtime; otherwise, false. + + + + Gets or sets whether a layout group’s indents, specified by its BaseLayoutItem.Spacing and BaseLayoutItem.Padding properties, are applied when the group’s borders are hidden. + + true if a layout group’s indents are applied when the group’s borders are hidden; otherwise, false. + + + + Allows the parent’s background to be seen through the LayoutControl. + + true if the parent’s background is seen through the LayoutControl; otherwise, false. + + + + Gets or sets the collapse/expand animation speed. + + An integer value that specifies the collapse/expand animation speed. + + + + Gets or sets whether controls are fitted to fill the entire height of the . + + true if controls are fitted to fill the entire height of the ; otherwise, false. + + + + Gets or sets whether controls are fitted to fill the entire width of the . + + true if controls are fitted to fill the entire width of the ; otherwise, false. + + + + Gets or sets the default group border and caption paint style. + + A value that specifies the group border and caption paint style. + + + + Gets or sets whether disabled layout items are highlighted according to the current skin. + + true if disabled layout items are highlighted; otherwise, false. + + + + Gets or sets whether focused layout items are highlighted according to the current skin. + + true if focused layout items are highlighted; otherwise, false. + + + + Gets or sets whether the layout control is read-only. + + A value that specifies if the layout control is read-only. + + + + Gets or sets the color used to paint layout item borders when they are visible. + + A value that specifies the color of layout item borders. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A PaddingMode value. + + + + Gets or sets whether the RightToLeft setting has been changed. + + true if the RightToLeft setting has been changed; otherwise, false. + + + + Determines whether the LayoutControl manages the look and feel and style settings of DevExpress .NET controls that are displayed within the LayoutControl. + + true if the look and feel and style settings of controls are determined by the LayoutControl.LookAndFeel property; otherwise, false. + + + + Gets or sets whether to use the default paint mechanism to indicate drag-and-drop operations. + + true if the default paint mechanism is used to indicate drag-and-drop operations; otherwise, false. + + + + Gets or sets whether indents between elements in the LayoutControl are automatically adjusted, based on the owning container’s auto-scale settings. + + true if indents between elements in the LayoutControl are automatically adjusted based on the owning container’s auto-scale settings; otherwise, false. + + + + Gets or sets whether padding settings (BaseLayoutItem.Padding and BaseLayoutItem.Spacing) of items and groups are obtained from the current skin. This is a backward compatibility option. + + true if padding settings of items and groups are obtained from the current skin; otherwise, false. + + + + Provides data for the LayoutControl.PopupMenuShowing and LayoutControl.LayoutTreeViewPopupMenuShowing events. + + + + + Initializes a new instance of the class with the specified settings. + + The menu to be displayed. This object is used to initialize the PopupMenuShowingEventArgs.Menu property. + The object that provides information on the clicked point. This object is used to initialize the PopupMenuShowingEventArgs.HitInfo property. + A Boolean value that specifies whether a menu can be displayed. This value is used to initialize the PopupMenuShowingEventArgs.Allow property. + + + + Initializes a new instance of the class with the specified settings. + + The menu to be displayed. This object is used to initialize the PopupMenuShowingEventArgs.Menu property. + The object that provides information on the clicked point. This object is used to initialize the PopupMenuShowingEventArgs.HitInfo property. + + + + Gets or sets whether the menu is allowed to be displayed. + + A Boolean value that specifies whether the menu is allowed to be displayed. + + + + Contains information on the clicked point within the Layout Control. + + An object that provides information on the clicked point. + + + + Gets or sets the menu that is about to be displayed. + + The menu that is about to be displayed. + + + + Gets the point at which the menu is about to be displayed. + + The point at which to display the menu. + + + + Defines a row in a table layout. + + + + + Initializes a new instance of a class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Initializes a new instance of a class with the specified settings. + + A layout group that owns the created object. + The height of the created row. This value is assigned to the RowDefinition.Height property. + The size type of the created row. This value is assigned to the RowDefinition.SizeType property. + + + + Initializes a new instance of a class with the specified owner. + + A layout group that owns the created object. + + + + Gets or sets the row height, in pixels or as a percentage, according to the RowDefinition.SizeType. + + A value that specifies the row height. + + + + Gets or sets the row’s size type in a table layout. + + A value that specifies the row’s size type. + + + + A row collection within a table layout. + + + + + Initializes a new instance of a class with the settings of the specified source object and with the specified owner. + + An object whose settings are used to initialize the created object. + A layout group that owns the created object. + + + + Initializes a new instance of a class with the specified owner. + + A layout group that owns the created object. + + + + Adds the specified row to the table layout. + + An object that specifies the row to be added. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + + + + Adds an array of row objects to the table layout. + + An array of objects to be added to the table layout. + + + + Inserts an element into the collection at the specified index. + + The zero-based index at which a rowDefinition should be inserted. + The to insert. + true, to recalculate the OptionsTableLayoutItem.RowIndex property of items in the current layout group; otherwise, false. + + + + Provides indexed access to rows within the current row collection. + + A zero-based integer value that specifies the index of the required row. + An object that represents the row at the specified position within the collection. + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + true, to recalculate the OptionsTableLayoutItem.RowIndex property of items in the current layout group; otherwise, false. + + + + Enumerates values that specify whether a ‘s maximum width, height, or both are calculated automatically based on the item’s content. + + + + + The item’s maximum width and height are calculated automatically based on the item’s content. + + + + + The mode is not specified explicitly. Enables the mode. + + + + + The item’s maximum width is calculated automatically based on the item’s content. + + + + + The item’s maximum width and height are not calculated automatically based on the item’s content. The maximum width and height are not limited. + + + + + The item’s maximum height is calculated automatically based on the item’s content. + + + + + An area in the that contains a label, but does not contain an embedded control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the item’s maximum width, height, or both are calculated automatically based on the item’s content. This property is only in effect if the property is set to . The value is equivalent to . + + A value that specifies whether the maximum width, height, or both are calculated automatically. + + + + Returns the property’s default value. + + A value that specifies the property’s default value. + + + + Gets a set of options that specify the image displayed in the item. + + An object that contains a set of image options. + + + + Gets or sets the item’s maximum size. This property is only in effect if the property is not set to . + + A structure that specifies the item’s maximum size. + + + + Gets or sets the item’s minimum size. This property is only in effect if the property is not set to . + + A structure that specifies the item’s minimum size. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + Always true. + + + + Gets the type’s name. + + A string value that specifies the type’s name. + + + + Enumerates size constraints modes. + + + + + A layout item’s size can be changed within the range which is specified by the LayoutControlItem.MinSize and LayoutControlItem.MaxSize properties. + + + + + Default size constraints are applied to the layout item and its control. The default size constraints are determined automatically depending upon the type of its control. + + + + + This mode is designed to support horizontal alignment of the controls that implement the automatic sizing feature, when they are displayed within a LayoutControl. A layout item’s maximum and minimum sizes are determined automatically. To custom align a control, set its AutoSizeInLayoutControl property to true and specify the control’s alignment via the LayoutControlItem.ContentHorzAlignment property. See Size and Alignment to learn more. + + + + + Allows you to resize and optionally collapse/expand adjacent layout items. Not supported in Table Layout and Flow Layout modes. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified parent. + + A object that owns the new splitter item. + + + + Gets whether the layout item’s borders are highlighted when the mouse cursor hovers over the layout items + + Always true. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the appearance settings used to paint an item’s caption. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A object which provides the appearance settings used to paint the item’s caption. + + + + Starts the item’s initialization. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Ends the item’s initialization. + + + + + Gets or sets whether and which layout item/group is fixed. + + A value that specifies whether and which layout item/group is fixed. + + + + Returns the splitter item’s name. + + A value that specifies the splitter item’s name. + + + + Returns the bounds of the region used to drag the splitter item. This method supports the internal infrastructure and is not intended to be used directly from your code. + + A Rectangle object. + + + + Gets or sets whether the splitter collapses leftwards (for the vertically oriented splitter) and upwards (for the horizontally oriented splitter), or in the opposite directions (rightwards and downwards, respectively). + + true if the splitter collapses rightwards and upwards; otherwise, false. + + + + Gets or sets whether the layout content is collapsed using the current splitter. + + true if the layout content is collapsed using the current splitter; otherwise, false. + + + + Gets or sets whether the layout content can be collapsed using the current splitter. + + True, if the layout content can be collapsed using the current splitter; otherwise, Default or False. + + + + Gets whether the splitter item is oriented horizontally. + + true if the splitter item is oriented horizontally; otherwise, false. + + + + Gets whether the splitter item is oriented vertically. + + true if the splitter item is oriented vertically; otherwise, false. + + + + Gets or set the maximum size of the splitter item. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure that defines the item’s maximum width and height. + + + + Gets or sets the minimum size of the splitter item. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure that defines the item’s minimum width and height. + + + + Gets or sets the amount of space in pixels between the item’s borders and its contents. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A DevExpress.XtraLayout.Utils.Padding object that contains inner indents between the layout item’s borders and its contents. + + + + Gets or sets the vertical (horizontal) separator position relative to the layout group left (top) edge. + + An integer value that specifies the separator position. + + + + Fires when the position of the current splitter in the layout is changed. + + + + + Gets or sets the splitter’s resize mode. + + A value that specifies the splitter’s resize mode. + + + + Gets or sets whether to display the split glyph. + + A value that specifies the spit glyph’s visibility. The DefaultBoolean.Default value, if the paint theme (skin) controls the split glyph visibility. + + + + Gets or sets the splitter item’s size. + + A structure that defines the splitter item’s width and height. + + + + Gets or sets the size constraints type. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A enumeration value which specifies the manner in which the item can be resized. The default is SizeConstraintsType.Default. + + + + Gets or sets the outer indents of the item’s borders. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A DevExpress.XtraLayout.Utils.Padding object that contains the outer indents of the layout item’s borders. + + + + Gets or sets the splitter’s width. + + An integer value that specifies the splitter’s width. + + + + Gets or sets the item’s text. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A value that specifies the item’s text. + + + + This member supports the internal infrastructure and is not intended to be used directly from your code. + + A value. + + + + Gets or sets the size of the text region. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + A structure that defines the width and height of the item’s text region. + + + + Gets whether the text region is visible. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. + + Always false. + + + + Gets the name of the item’s type. + + The ‘SplitterItem’ value. + + + + Contains values that specify whether and which layout item/group is fixed. + + + + + The left or top item is fixed (depending on the SplitterItem’s orientation). + + + + + No item is fixed. + + + + + The right or bottom item is fixed (depending on the SplitterItem’s orientation). + + + + + Enumerates the options that control how layout items are resized when using a splitter. + + + + + Moving the splitter changes the size of adjacent layout items and all their neighbors even if they belong to other layout groups. + + + + + Moving the splitter allows adjacent layout items that belong to the same layout group to be resized (the layout item to the left, and all layout items to the right/top are allowed to be resized). + + + + + The group that features a tabbed UI. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with the specified owner. + + A object or descendant which owns the created group. + + + + Creates a new tab page and appends it to the TabbedControlGroup.TabPages collection. + + A object that represents the new page. + + + + Appends the specified tab page to the TabbedGroup.TabPages collection. + + A object or descendant that represents a new tab page. + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + true if the tab page is selected; otherwise, false. + A object or descendant that represents a new tab page. + + + + Appends the specified tab page with the specified text to the TabbedControlGroup.TabPages collection. + + A object or descendant that represents the new tab page. + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + A object that represents the new page. null (Nothing in Visual Basic) if the collection contains the specified tab page. + + + + Appends the specified tab page to the TabbedControlGroup.TabPages collection. + + A object or descendant that represents the new tab page. + A object that represents the new page. null (Nothing in Visual Basic) if the collection contains the specified tab page. + + + + Creates a new tab page with the specified text and appends it to the TabbedControlGroup.TabPages collection. + + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + A object that represents the new page. + + + + Gets the collection of layout groups which is owned by the current tabbed group. + + A DevExpress.XtraLayout.Utils.TabbedGroupsCollection object which represents the collection of layout groups owned by the tabbed group. + + + + Represents the base class for tabbed layout groups. + + + + + Invokes the Visit method of the specified visitor for each item that belongs to the current layout tabbed group. + + A DevExpress.XtraLayout.Utils.BaseVisitor class descendant. + + + + Adds a new tabbed page to the current tabbed group. + + A object or descendant which represents the new page. + + + + Appends the specified tab page to the TabbedGroup.TabPages collection. + + A object or descendant that represents a new tab page. + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + true if the tab page is selected; otherwise, false. + A object or descendant that represents a new tab page. + + + + Appends the specified tab page with the specified text to the TabbedGroup.TabPages collection. + + A object or descendant that represents the new tab page. + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + A object or descendant that represents the new page. null (Nothing in Visual Basic) if the collection contains the specified tab page. + + + + Appends the specified tab page to the TabbedGroup.TabPages collection. + + A object or descendant that represents the new tab page. + A object or descendant that represents the new page. null (Nothing in Visual Basic) if the collection contains the specified tab page. + + + + Creates a new tab page with the specified text and appends it to the TabbedGroup.TabPages collection. + + A value that specifies the text displayed within the page header. This value is assigned to the BaseLayoutItem.Text property. + A object or descendant that represents the new page. + + + + Gets or sets whether or not tabbed group captions can be formatted using HTML tags. + + true if tabbed group captions can be formatted using HTML tags; otherwise, false. + + + + Gets or sets default padding for images displayed in the page headers belonging to the current group. + + A Padding object that specifies default padding for images displayed in the page headers belonging to the current group. + + + + Removes all tab pages from the TabbedControlGroup.TabPages collection. + + + + + Removes all tab pages from the TabbedControlGroup.TabPages collection. + + true, to release all resources; otherwise false. + + + + Allows you to custom paint header buttons (TabbedGroup.CustomHeaderButtons). + + + + + Allows you to custom paint tabs. + + + + + Occurs when a custom header button is clicked. + + + + + Provides access to the collection of custom buttons displayed in the tabbed group header. + + The object that represents a collection of custom buttons displayed in the tabbed group header. + + + + Finishes the component’s initialization. + + + + + Gets or sets whether tab headers are stretched to the width of the ‘s header region. + + A value that specifies whether tab headers are stretched to the width of the ‘s header region. + + + + Gets or sets the orientation of tab headers. + + A enumeration member which specifies the orientation of tab headers. + + + + Adds the page to the TabbedGroup.TabPages collection before or after the specified page. + + A object or descendant that represents the page before or after which the page will be inserted. + A object or descendant which represents the inserted page. + An enumeration value which specifies the position that the page will be inserted at. + + + + Adds the specified page to the TabbedGroup.TabPages collection at the specified position. + + An integer value which represents the zero-based index at which the specified page should be inserted. If it’s negative or exceeds the number of elements within the collection an exception is thrown. + A object or descendant which represents the inserted page. + + + + Gets the maximum size of the tabbed group. + + A structure that specifies the tabbed group’s maximum size. + + + + Gets the minimum size of the tabbed group. + + A structure that defines the tabbed group’s minimum width and height. + + + + Moves the page to another position within the TabbedGroup.TabPages collection. + + A object which contains information on the page that would be moved and the position that the page would be moved to. + true if the page has been moved; otherwise, false. + + + + Gets or sets whether more than one row of tabs can be displayed. + + A value that specifies whether tabs can be arranged in multiple rows. + + + + This property is not supported by the class. + + A object. + + + + Gets or set the LayoutControl that owns the current tabbed group. + + A object or descendant which the tabbed group belongs to. + + + + Gets or sets the alignment of images displayed within headers of pages that belong to the current group. + + A value that specifies the alignment of images displayed within headers of pages that belong to the current group. + + + + Removes the specified tab page from the TabbedControlGroup.TabPages collection. + + A object which represents the tab page to be removed from the collection. + true if the tab page has been removed; otherwise, false. + + + + Occurs when a tab page is activated. + + + + + Enables you to prevent changing the selected page. + + + + + Gets or sets the currently selected layout group within the tabbed group. + + A object which represents the tabbed page that is currently selected. + + + + Gets or sets the index of the currently selected tab page. + + A zero-based integer which specifies the index of the selected tab page. + + + + Gets or sets the name of the tab page currently being selected. + + A value that specifies the name of the tab page currently being selected. + + + + Gets or sets whether tab headers are shown. + + A enumeration value that specifies whether tab headers are shown. + + + + Gets the collection of layout groups which is owned by the current tabbed group. + + A DevExpress.XtraLayout.Utils.TabbedGroupsCollection object which represents the collection of layout groups owned by the tabbed group. + + + + Gets or sets the size of the text region. + + A System.Drawing.Size structure that defines the width and height of the text region. + + + + Gets or sets whether the current object’s text region is visible. This property is not supported by the class. + + Always false. + + + + Provides access to state animation parameters. + + A DevExpress.XtraTab.XtraTabControlTransition object that specifies state animation parameters. + + + + Gets the name of the item’s type. + + The ‘TabbedGroup’ value. + + + + Ungroups the tabbed group. + + + + + Gets the object which contains the information used to render the tabbed group. + + A DevExpress.XtraLayout.ViewInfo.TabbedGroupViewInfo object. + + + + Enumerates the options that specify how the controls, displayed within the LayoutControl, are aligned and the corresponding text regions are resized. + + + + + Controls are auto-aligned independently within each layout group. + + + + + For internal use. + + + + + Controls are auto-aligned throughout the LayoutControl. + + + + + The auto-size feature is enabled. The text regions of layout items are automatically resized to the minimum width that allows the text to be displayed in it entirety. + + + + + Enables custom size mode, in which the size of the text regions of all layout items must be specified manually via the BaseLayoutItem.TextSize property. + + + + + Enumerates the options that specify how the controls, displayed within a specific layout group, are aligned and the corresponding text regions are resized. + + + + + Controls displayed within the current group are equally aligned independent of other groups. + + + + + Controls displayed within the current and nested groups are equally aligned independent of other groups. + + + + + The auto-size feature is applied to the layout items of the current group. The text regions of the layout items are automatically resized to the minimum width that allows the text to be displayed in its entirety. + + + + + Enables custom size mode, in which the size of the text regions of the group’s layout items must be specified manually via the BaseLayoutItem.TextSize property. + + + + + Alignment settings are determined by the group’s parent. The OptionsItemTextGroup.TextToControlDistance and OptionsItemTextGroup.AlignControlsWithHiddenText properties of the current group are ignored. In this mode, these settings are determined by the group’s parent. + For the root group, its parent is the LayoutControl itself (the LayoutControl’s alignment settings are specified by the LayoutControl.OptionsItemText property). For other groups their parents are upper-level groups (a group’s alignment settings are specified by the LayoutGroup.OptionsItemText property). + + + + + Enumerates the options that determine the alignment settings of a layout item’s control. + + + + + The auto-size feature is applied to the current layout item. The item’s text region is automatically resized to the minimum width that allows the text to be displayed in its entirety. + + + + + Enables custom size mode, in which the size of the layout item’s text region must be specified manually via the BaseLayoutItem.TextSize property. + + + + + Alignment settings are determined by the item’s parent. The item’s BaseLayoutItem.TextToControlDistance property is ignored. In this mode, this setting is determined by the item’s parent. + The item’s immediate parent is a group which provides the LayoutGroup.OptionsItemText property to control the alignment settings of its items. However, by default the group’s OptionsItemTextGroup.TextAlignMode property is set to TextAlignModeGroup.UseParentOptions. In this mode, the alignment settings of the group’s items are determined by the group’s parent. + For the root group, its parent is the LayoutControl itself (the LayoutControl’s alignment settings are specified by the LayoutControl.OptionsItemText property). For other groups their parents are upper-level groups (a group’s alignment settings are specified by the LayoutGroup.OptionsItemText property). + + + + + Contains utility classes for the Layout Control. + + + + + Lists the values that specify the position to which a layout item is inserted. + + + + + To insert an item after the specified one. + + + + + To insert an item before the specified one. + + + + + Lists values that specify the inserted layout item’s position relative to another item. + + + + + Inserts an item below another item. + + + + + Inserts an item to the left of another item. + + + + + Inserts an item to the right of another item. + + + + + Inserts an item above another item. + + + + + Provides data for the LayoutControl.GroupExpandChanging event. + + + + + Initializes a new instance of the class with the specified settings. + + The currently processed group. + The value that specifies whether the current operation needs to be canceled. + + + + Gets or sets whether to cancel the current operation. + + A Boolean value that specifies whether to cancel the current operation. + + + + Provides data for the LayoutControl.GroupExpandChanged and LayoutControl.TabPageCloseButtonClick events. + + + + + Initializes a new instance of the class with the specified settings. + + A object that represents the group to which the created object will refer. This value is used to initialize the LayoutGroupEventArgs.Group property. + + + + Gets the group currently being processed. + + A object that refers to the group currently being processed. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the LayoutControl control which fires the event. + A object that contains data for the event. + + + + Stores layout elements (descendants of the base class). + + + + + Initializes a new instance of the class with the default settings. + + + + + Initializes a new instance of the class with specified settings. + + + + + Creates a new and places it inside this . + + A object that has been created. + + + + Creates a new and places it inside this . + + A object that has been created. + + + + Creates a new object and places it inside this . + + A object that has been created. + + + + Returns a that owns this . + + A object that owns this . + + + + Enumerates values that specify the layout mode for a . + + + + + Flow layout mode. Layout items are automatically arranged in rows according to their order in the LayoutGroup.Items collection, and are automatically wrapped at the group’s right edge + + + + + Regular layout mode. Layout items can stretch within the parent layout group and can have any size + + + + + Table layout mode. Layout items are arranged in a two-dimensional table according to their row and column indexes and span values. + + + + + Contains the values that specify how an item is positioned next to a base item. + + + + + Specifies that an item is positioned horizontally next to a base item. + + + + + Specifies that an item is positioned vertically next to a base item. + + + + + Enumerates values that specify whether a layout item is visible in the Layout Control and the Customization Form. + + + + + A layout item is not collapsed. It is displayed in its original size in regular and customization modes. + + + + + A layout item is collapsed. + + + + + A layout item is visible in customization mode, and collapsed in regular mode (when customization is not performed). + + + + + A layout item is visible in regular mode, and collapsed in customization mode. + + + + + Lists the values that specify how a layout item is inserted to another position. + + + + + An item is inserted inside the specified item. + + + + + An item is inserted outside the specified item. In this case, the inserted item is reduced to its minimum size which is specified by its BaseLayoutItem.MinSize property. + + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.dll b/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.dll new file mode 100644 index 0000000..0ca282b Binary files /dev/null and b/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.dll differ diff --git a/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.xml b/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.xml new file mode 100644 index 0000000..861d6df --- /dev/null +++ b/BitgetApi/bin/Debug/DevExpress.XtraTreeList.v23.2.xml @@ -0,0 +1,11062 @@ + + + + DevExpress.XtraTreeList.v23.2 + + + + + Contains editor classes that implement the functionality for corresponding controls. + + + + + Contains classes representing repository items that store editor-specific settings. + + + + + A repository item which stores settings specific to a control. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the ‘s nodes are automatically focused when hovered with the mouse pointer. + + true if the ‘s nodes are automatically focused when hovered with the mouse pointer; otherwise, false. + + + + Copies settings of the specified repository item. + + A object or its descendant that represents the source of the operation. + + + + Gets or sets whether the editor predicts the value that the user is typing and automatically applies that value. The property is in effect when text editing is enabled in the edit box (TextEditStyle is set to Standard). + + true if the editor predicts the value that the user is typing and automatically applies that value; otherwise, false. + + + + Gets or sets whether all nodes are automatically expanded when the Tree List is being loaded. + + true, to expand all nodes when the Tree List is being loaded; otherwise, false. + + + + Returns the ExportMode.Default value, which is equivalent to ExportMode.DisplayText. + This constant is used to initialize the RepositoryItem.ExportMode property. + + + + + Returns “TreeListLookUpEdit”. This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets the class name of an editor corresponding to the current repository item. + + The string identifying the class name of a corresponding editor. + + + + Returns the text representation of the specified value, formatted according to the specified settings. + + A object that specifies formatting settings. + A value to be formatted. + A string that specifies the value’s formatted text representation. + + + + Returns the text representation of the DisplayMember field value of the specified row. + + An integer that is the index of the required row. + The text representation of the DisplayMember field value for the specified row. + + + + Returns the text representation of the DisplayMember field value of the row that contains the specified ValueMember field value. + + The value of the ValueMember field for the row to locate. + The text representation of the DisplayMember field value for the specified row. + + + + Returns the index of the row that contains the specified value in the ValueMember field. + + The value of the ValueMember field for the row to locate. + An integer that specifies the index of the required row. + + + + Returns the key value contained in the specified row. + + An integer that is the index of the required row. + The value of the row’s ValueMember field. + + + + Returns a data source row containing the specified value in the RepositoryItemLookUpEditBase.ValueMember field. + + The value of the RepositoryItemLookUpEditBase.ValueMember field for the row to be located. + An object representing the data source record containing the specified value. null (Nothing in Visual Basic) if no record with the specified value in the RepositoryItemLookUpEditBase.ValueMember field was found. + + + + Gets the editor which owns the current repository item object. + + A control owning the current repository item. + + + + Gets or sets how records in the dropdown window are filtered when typing text within the edit box. + + A value that specifies the editor’s popup filter mode. + + + + Registers the control. + + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets a associated with the current control. + + A associated with the current control. + + + + The data-aware editor that implements lookup functionality using a dropdown control. This editor cannot operate if no data source is connected to it. + + + + + Initializes a new instance of the class. + + + + + Gets the class name of the current editor. + + A string that is the class name of the current editor. + + + + Returns a data source row corresponding to the currently selected edit value. + + An object that represents a data source row corresponding to the currently selected edit value. + + + + Specifies settings specific to the current editor. + + A object containing settings for the editor. + + + + Contains classes that implement the functionality of the Tree List control. + + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The node that the user has dropped. This value is assigned to the property. + The parent node. This value is assigned to the property. + true if the user copied the node; otherwise, false. + true if the node was copied or moved to another node (position); otherwise, false. This value is assigned to the property. + + + + Gets a parent node that owns the dropped node. + + The parent node. + + + + Gets whether the user copied or moved a node. + + true if the user copied the node; otherwise, false. + + + + Gets whether a node was copied or moved to another node (position). + + true if the node was copied or moved to another node (position); otherwise, false. + + + + Gets a node that the user has dropped. + + The node that the user has dropped. + + + + Provides data for the TreeList.BeforeCollapse event. + + + + + Initializes a new class instance. + + A Tree List node. + + + + Gets or sets a value indicating whether a Tree List node can collapse. + + true if a Tree List node can collapse; otherwise, false. + + + + Represents a method that will handle the TreeList.BeforeCollapse event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.BeforeDragNode event. + + + + + Initializes a new class instance. + + A Tree List node. + + + + Initializes a new instance of the class with the specified settings. + + A list of nodes that are about to be dragged. + The node that is focused when a drag-and-drop operation starts. + + + + Gets or sets a value indicating whether a Tree List node can be dragged. + + true if a Tree List node can be dragged; otherwise, false. + + + + Gets the list of nodes that are about to be dragged. + + The list of nodes that are about to be dragged. + + + + Gets or sets the image displayed near the mouse cursor during a drag-and-drop operation. + + An object specifying the image displayed near the mouse cursor during a drag-and-drop operation. + + + + Represents a method that will handle the TreeList.BeforeDragNode event of the class. + + The event source. + A class instance containing event data. + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + The node that the user is about to drop. This value is assigned to the property. + The parent node. + The position of the node among the child nodes of the parent node after drop. This value is assigned to the property. + true if the user copied the node; otherwise, false. This value is assigned to the property. + + + + Gets or sets a value that specifies whether to cancel the action. + + true to cancel the action; otherwise, false. + + + + Gets the position of the node among the child nodes of the parent node after drop. + + A zero-based integer value that specifies the node’s index in the child nodes collection of the parent node. + + + + Gets a parent node that owns the dropped node. + + The parent node. + + + + Gets whether the user copied or moved a node. + + true if the user copied the node; otherwise, false. + + + + Gets a node that the user is about to drop. + + The node that the user is about to drop. + + + + Provides data for the TreeList.BeforeExpand event. + + + + + Initializes a new class instance. + + A Tree List node. + + + + Gets or sets whether a Tree List node can be expanded. + + true if a Tree List node can be expanded; otherwise, false. + + + + Represents a method that will handle the TreeList.BeforeExpand event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.BeforeFocusNode event. + + + + + Creates an instance of the class. + + A object representing the node from which focus is shifting. This value is assigned to the FocusedNodeChangedEventArgs.OldNode property. + A object representing the node which is about to obtain focus. This value is assigned to the NodeEventArgs.Node property. + + + + Gets or sets a value indicating whether focus is allowed to be moved. + + true if the focus is allowed to be moved; otherwise false. + + + + Represents a method that will handle the TreeList.BeforeFocusNode event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CalcNodeDragImageIndex event. + + + + + Initializes a new instance of the class. + + A object which represents the target node. This value is assigned to the NodeEventArgs.Node property. + An integer value specifying the index of the image in the source collection. This value is assigned to the CalcNodeDragImageIndexEventArgs.ImageIndex property. + A structure representing the mouse pointer’s coordinates relative to the top-left corner of the control. This value is assigned to the CalcNodeDragImageIndexEventArgs.PtClient property. + A object which provides data for the drag-and-drop events. This value is assigned to the CalcNodeDragImageIndexEventArgs.DragArgs property. + + + + Gets an object which provides information for drag-and-drop events. + + A object which provides data for drag-and-drop events. + + + + Gets or sets the index of the image to be displayed in front of nodes when dragging. + + An integer value representing the zero-based index of the desired image within the TreeList.Painter.NodeDragImages collection. + + + + Gets the current mouse pointer’s coordinates relative to the top-left corner of the control. + + A structure representing the current mouse pointer’s coordinates. + + + + Represents a method that will handle the TreeList.CalcNodeDragImageIndex event. + + The event source (typically, the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CalcNodeHeight event. + + + + + Creates an instance of the class. + + A object representing the node whose height is calculated. This value is assigned to the NodeEventArgs.Node property. + An integer value specifying the node height. This value is assigned to the CalcNodeHeightEventArgs.NodeHeight property. + + + + Gets or sets the current node’s height in pixels. + + An integer value specifying the node’s height in pixels. + + + + Represents a method that will handle the TreeList.CalcNodeHeight event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for events which require column and node as parameters to identify the cell being processed. + + + + + Creates an instance of the class. + + A object representing the column to which the processed cell belongs. This value is assigned to the CellEventArgs.Column property. + A object representing the node to which the processed cell belongs. This value is assigned to the NodeEventArgs.Node property. + + + + Gets a column to which the cell processed by an event belongs. + + A object representing the column owning the cell being processed. + + + + Provides data for the TreeList.CellValueChanged and TreeList.CellValueChanging events. + + + + + Initializes a new class instance. + + The processed column. + The processed node. + The new value. + true, if the user changed the value in an editor; false, if the value is changed in code. + + + + Initializes a new instance of the class with specified settings. + + + + + Gets whether the user changed the value in an editor, or the value is changed in code. + + true, if the user changed the value in an editor; false, if the value is changed in code. + + + + Gets the new value assigned to a cell. + + An object representing the newly assigned cell value. + + + + Represents a method that will handle the TreeList.CellValueChanged and TreeList.CellValueChanging events. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the event. + + + + + Provides access to the collection of cells in the processed column header, or band header. + + An object that represents a collection of cells. + + + + Gets the handle of the processed node. + + A zero-based integer value that identifies the processed node. -2147483648 if the processed row is not a node. + + + + Gets the type of the processed row. + + A value that specifies the row type. + + + + Provides access to the collection of cells in the processed node. + + An object that represents a collection of cells. + + + + Provides data for the TreeList.ClipboardNodePasting event. + + + + + Initializes a new class instance. + + A dictionary that contains values that will be pasted to the control. + A collection that contains tree list columns. + A collection that contains original values in the clipboard. + The node being updated or the parent node if the node is being appended. + A value that specifies the count of rows that contain data to process (without column and band header rows). + A value that specifies the total count of rows to process (with column and band header rows). + + + + Gets or sets whether the current operation needs to be canceled. + + true if the current operation needs to be canceled; otherwise, false. + + + + Gets the count of rows that contain data to process (without column and band header rows). + + An value that specifies the count of data rows to process. + + + + Returns a dictionary that contains invalid column-value pairs. Invalid pairs identify values that cannot be accepted by corresponding columns. + + A dictionary of incompatible column-value pairs. The keys in the dictionary are objects. The dictionary values are of the object type. + + + + Returns a dictionary that contains valid column-value pairs. Valid pairs identify values that can be accepted by corresponding columns. + + A dictionary of compatible column-value pairs. The keys in the dictionary are objects. The dictionary values are of the object type. + + + + Returns whether the key of the processed node is unique. + + true if the key is unique; otherwise, false. + + + + Returns whether pasted values can be accepted by target columns. Both the pasted values and target columns are specified by the ClipboardNodePastingEventArgs.Values dictionary. + + true if the pasted values can be accepted by target columns; otherwise, false. + + + + Returns whether the specified value can be pasted to the specified column cell. + + The column to be tested. + The value to be tested. + The exception that specifies the error description. null if no error occurs. + true if the specified value can be pasted to the specified column’s cell; otherwise, false. In case of failure, read the e output parameter to get details. + + + + Returns whether the specified value can be pasted to the column with the specified field name. + + The field name that identifies the column to be tested. + The value to be tested. + The exception that specifies the error description. null if no error occurs. + true if the specified value can be pasted to the specified column; otherwise, false. In case of failure, read the e output parameter to get details. + + + + Returns a read-only collection of individual pasted values. + + The read-only collection of individual pasted values. + + + + Gets or sets whether only valid rows or all rows are pasted to the control. + + A value that specifies whether only valid rows or all rows are pasted to the control. + + + + Gets the total count of rows to process (with column and band header rows). + + An value that specifies the total count of rows to process. + + + + Depending on the paste mode, returns the parent node relative to which the data is appended, or the updated node. + + A object specifying the node relative to which the paste operation is performed. + + + + Returns a dictionary that contains “target column - pasted value” pairs. You can modify pasted values in this dictionary to perform custom pasting. + + The dictionary of “target column - pasted value” pairs. + + + + Provides data for the TreeList.ColumnChanged event. + + + + + Creates an instance of the class. + + A object representing the column related to the event. This value is assigned to the ColumnChangedEventArgs.Column property. + + + + Gets a Tree List column. + + A Tree List column. + + + + Represents a method that will handle the TreeList.ColumnChanged event of the class. + + The event source. + A class instance containing event data. + + + + Enumerates values that specify the pop-up filter menu style. + + + + + Menu contains a value list or a calendar depending on the data type. + + + + + Inherites the WindowsFormsSettings.ColumnFilterPopupMode property value. + + + + + Menu contains two tabs: a value checklist and data-specific predefined filters. + + + + + Contains classes that represent columns for the Tree List control. + The Tree List control supports multi-column Views: each node can contain several columns representing different data. + To access specific column elements, the methods of the class are used. Like Grid Control columns, it is possible to assign specific editors to Tree List columns. + The TreeList.Columns property provides a column collection which identifies columns for the XtraTreeList. Every Tree List node will contain several values in a row according to the column number. + + + + + Enumerates the comparison operator types for the filter conditions created for specific columns via the Automatic Filtering Row. + + + + + Selects records that start with the entered string. Equal to the AutoFilterCondition.Like clause with the “%” wildcard after the searched string. + For example, the [Name] BeginsWith ‘A’ and [Name] Like ‘A%’ filtering expressions are equal. + + + + + The Contains operator selects records whose values in the corresponding column contain the entered string. + + + + + For columns being filtered by their display text (see TreeListColumn.FilterMode), the Default option acts identically to the Like option. + The Default option acts like the Equals option for the columns that have any of the following in-place editors or any of their descendants: , , or . + For other columns, the Default option acts identically to the Like option. + + + + + Selects records that do not equal the entered string. This clause acts as an opposite to the AutoFilterCondition.Equals clause. + + + + + Selects records that do not equal the entered string. This clause acts as an opposite to the AutoFilterCondition.Equals clause. + + + + + Selects records that end with the entered string. Equal to the AutoFilterCondition.Like clause with the “%” wildcard before the searched string. + For example, the [Name] EndsWith ‘A’ and [Name] Like ‘%A’ filtering expressions are equal. + + + + + The Equals comparison operator selects records whose values in the corresponding column match the entered value. + + + + + Selects records that are greater than the entered value. + For text records, “greater” values are those that would lie below the entered value in an alphabetically sorted list. For example, in a list with Latin characters, all letters from “N” to “Z” are greater than the letter “M”. + + + + + Selects records that are greater than the entered value or equal to it. + For text records, “greater” values are those that would lie below the entered value in an alphabetically sorted list. For example, in a list with Latin characters, all letters from “M” to “Z” are greater or equal to the letter “M”. + + + + + Selects records that are less than the entered value. + For text records, “less” values are those that would lie above the entered value in an alphabetically sorted list. For example, in a list with Latin characters, all letters from “A” to “L” are less than the letter “M”. + + + + + Selects records that are less than the entered value or equal to it. + For text records, “less” values are those that would lie above the entered value in an alphabetically sorted list. For example, in a list with Latin characters, all letters from “A” to “L” are less than the letter “M”. + + + + + The Like comparison operator selects records whose values in the corresponding column start with the entered string. + For the columns that use , , or in-place editors, the Equals operator is always used, unless these columns are filtered by display text (see TreeListColumn.FilterMode). + + + + + Selects records that do not match the entered string. Acts as an opposite to the AutoFilterCondition.Like clause. + For example, from a list with month names the [Name] Like ‘J%y’ filter expression will return the “January” and “July” records. The [Name] Not Like ‘J%y’ expression will return the names of remaining ten months. + + + + + Enumerates values that specify whether a column is anchored at the control’s left or right edge. + + + + + The column is anchored at the control’s left edge. + + + + + The column is not anchored. + + + + + The column is anchored at the control’s right edge. + + + + + A band that combines Tree List columns. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + Specifies whether the band and all its parents are visible. + + true if the current band is visible within the ; otherwise, false. + + + + Provides access to appearance settings used to paint the band header. + + An object that specifies appearance settings used to paint the band header. + + + + Provides access to the band’s child band collection. + + An object that specifies the band’s child band collection. + + + + Gets or sets the band caption to be displayed within the band header. + + A value that specifies the band header. + + + + Provides access to the column collection owned by the current band. + + A value that specifies the column collection owned by the current band. + + + + Gets or sets the band caption when its header is displayed in the Customization Form. + + A value that specifies the band caption when its header is displayed in the Customization Form. + + + + Gets the band caption when its header is displayed in the Customization Form by which it can be found using the Customization Form’s search box. + + A string value specifying the band caption when its header is displayed in the Customization Form by which it can be found using the Customization Form’s search box. + + + + The default value for the TreeListBand.MinWidth property. The DefaultBandMinWidth field is set to 20. + + + + + The default value for the TreeListBand.Width property. The DefaultBandWidth field is set to 75. + + + + + Specifies the minimum allowed value of the TreeListBand.MinWidth property. The DefaultMinimumMinBandWidth field is set to 16. + + + + + Gets or sets the band’s behavior when the control is scrolled horizontally. + + A value that specifies the band’s behavior when the control is scrolled horizontally. + + + + Returns the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Returns the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Returns the band’s caption. + + A String value specifying the band’s caption. + + + + Returns the non formatted band caption. + + A value that specifies the non formatted band caption. + + + + Gets whether the current band has child bands. + + true if the current band contains one or more child bands; otherwise, false. + + + + Gets whether the current band has visible child bands. + + true if the current band contains one or more visible child bands; otherwise, false. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.XtraTreeList.Columns.TreeListBandImageOptions object that stores image-related options. + + + + Provides access to the source of images that can be displayed within column headers and bands. + + An object that is the source of images that can be displayed within column headers and bands. + + + + Gets the index of the current band within the owning collection. + + -1, if the band has no owning collection; otherwise, a zero-based index that specifies the band’s position within the owning collection. + + + + Gets whether this band contains a column that displays the node expand/collapse buttons. + + true if this band contains a column that displays the node expand/collapse buttons; otherwise, false. + + + + Indicates whether the control owning the current band is being initialized. + + true if the control is being initialized; otherwise, false. + + + + Gets the nesting level of the current band in the band hierarchy. + + A zero-based value that specifies the band’s nesting level. + + + + Gets or sets the band’s minimum allowed width. + + A value that specifies the band’s minimum width, in pixels. + + + + Gets or sets the band name. + + A value that specifies the band name. + + + + Provides access to the band’s options. + + A value that specifies the band’s options. + + + + Gets the band’s parent. + + An object that specifies the band’s parent. + + + + Gets the root band that is the current band’s parent. + + An object that specifies the root band in the current hierarchy branch. + + + + Gets or sets the band header height, in logical rows. + + The band header height, in logical rows. Values less than 1 are not accepted. + + + + Scales the band according to the current DPI setting. For internal use. + + A ScaleHelper object. + + + + Gets or sets the width, in pixels, of the band separator (grid vertical lines that visually separate this band from other bands). + + An integer value that specifies the band separator width, in pixels. + + + + Gets or sets a regular tooltip. + + A value that specifies a regular tooltip. + + + + Gets the band’s caption. + + A string that specifies the band’s caption. + + + + Gets a object to which the current band belongs. + + An object that specifies the object to which the current band belongs. + + + + Specifies whether the current band is visible. + + true if the current band is visible; otherwise, false. + + + + Returns the current band width. + + A value that specifies the current band width, in pixels. + + + + Gets or sets the band’s width. + + A value that specifies the band’s width, in pixels. + + + + A band collection within a . + + + + + Initializes a new instance of a class. + + A object that will own the created band collection. This value is assigned to the TreeListBandCollection.OwnerBand property. + A object that will own the created band collection. This value is assigned to the TreeListBandCollection.TreeList property. + + + + Initializes a new instance of the class. + + A object that will own the created band collection. This value is assigned to the TreeListBandCollection.OwnerBand property. + + + + Creates a new band and adds it to the band collection. + + An object that specifies the new band. + + + + Adds the specified band to the end of the band collection. + + An object that specifies the band to be added. + An object specifying the new band. + + + + Creates a new band with the specified caption and appends it to the band collection. + + A value that specifies the band’s caption. This value is assign to the TreeListBand.Caption property. + An object that specifies the new band. + + + + Adds an array of bands to the end of the band collection. + + An array of bands to be added to the collection. + + + + Returns whether the specified band is contained within the current band collection or any of its bands’ TreeList.Bands collections. + + An object that specifies the band to be found. + true if the search should be extended to the TreeListBand.Bands collections of the current collection’s bands; otherwise, false. + true if the specified band is found; otherwise, false. + + + + Create a new instance of the class with default settings. + + An object that specifies the created band. + + + + Executes the specified action on each element of the collection. + + The delegate to execute on each element of the collection. + + + + Returns the specified band’s position within the collection. + + An object that specifies the band to locate. + The zero-based index of the specified band within the collection; -1, if the collection does not contain the specified band. + + + + Inserts the specified band to the specified position within the band collection. + + The zero-based index at which the specified band should be inserted. + An object to be inserted. + + + + Provides indexed access to the band collection. + + The band’s zero-based index. + The band located at the specified position within the collection. + + + + Returns a band with the specified name within the collection. + + The band with the specified name; null (Nothing in visual basic) if no band is found. + The band’s name to be found. + + + + Gets a band that owns the current collection. + + An object that specifies the band owning the current collection. + + + + Removes the specified band from the band collection. + + An object that specifies the band to be removed. + + + + Changes the specified band’s position within the collection. + + A new band position within the collection. + An object that specifies the band to be moved. + + + + Gets a object that owns the current collection. + + An object owning the current collection. + + + + Gets the number of visible bands within the collection. + + A value that specifies the number of visible bands. + + + + Represents a single column in the control. + + + + + Initializes a new class instance. + + + + + Gets or sets a column’s position within the Tree List’s column collection. + + An integer value representing the column’s zero based index within the collection. + + + + Gets or sets the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Gets or sets the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Gets or sets the object’s accessible role. + + The object’s accessible role. + + + + Gets the actual maximum column width. + + An integer value that specifies the actual maximum column width. + + + + Gets the actual minimum column width. + + An integer value that specifies the actual minimum column width. + + + + Specifies whether a summary is calculated against all Tree List nodes or against root nodes only. + + true if a summary is calculated against all Tree List nodes; otherwise, it is calculated only against root nodes. + + + + Gets or sets whether incremental searches can be performed against the column. + + true if incremental searches can be performed against the column; otherwise, false. + + + + Gets the appearance settings used to paint the column’s cells. + + An object that provides the appearance settings used to paint the column cells. + + + + Gets the appearance settings used to paint the column header. + + A object that contains the column header’s appearance settings. + + + + Adjusts the width to display the contents of the column’s cells, header and summaries optimally. + + + + + Gets or sets the column caption displayed in the HeaderPanel of the XtraTreeList. + + Column caption. + + + + Gets data annotation attributes applied to this . + + An AnnotationAttributes object that stores data annotation attributes applied to this . + + + + Gets or sets the repository item that specifies the editor used to edit a column’s cell values. + + A descendant. + + + + Gets or sets the name of the editor used for this column’s cells. + + A string value specifying the column cell’s editor name. + + + + Gets the position of the associated field within the data source. + + An integer value representing the zero-based index of the corresponding field within the data source. + + + + Gets the horizontal position of a banded column. + + The zero-based index that specifies the column position within the band. + + + + Gets the column’s data type. + + A value that indicates the column’s data type. + + + + Gets or sets the column header in the Customization Form. + + A value that specifies the column header in the Customization Form. + + + + Gets the column caption when its header is displayed in the Customization Form by which it can be found using the Customization Form’s search box. + + A string value specifying the column caption when its header is displayed in the Customization Form by which it can be found using the Customization Form’s search box. + + + + Gets or sets the field name assigned to the current column from a datasource. + + A value that specifies the name of a data field. + + + + Gets or sets by what data field this column should sort and filter its data. + + A String value that specifies the name of a data field which should be used by this column to perform sorting and/or filtering. + + + + Gets an object specifying custom filter criteria. + + A DevExpress.XtraTreeList.Columns.TreeListColumnFilterInfo object specifying the filter criteria to be applied. + + + + Gets or sets whether to filter data by the displayed text or actual values. + + A enumeration value that specifies how the column’s values are filtered. + + + + Gets or sets whether the column is anchored to the control’s left or right edge. + + A value that specifies whether the column is anchored to the control’s left or right edge. + + + + Gets the object that specifies the formatting applied to column values. + + A object that specifies formatting settings for column values. + + + + Returns the object’s description used by accessibility client applications. + + The object’s description used by accessibility client applications. + + + + Returns the object’s name used by accessibility client applications. + + The object’s name used by accessibility client applications. + + + + Returns the column’s display caption. + + A string that specifies the column’s display caption. + + + + Gets this ‘s description, assigned by a related data attribute. + + A String value that is this ‘s description, assigned by a related data attribute. + + + + Returns the column header width that allows the content to be displayed in its entirety. + + An integer value that specifies the width. + + + + Returns the column’s plain text caption. + + A string value that represents the column’s plain text caption. + + + + Gets or sets the image displayed in the column header. + + An Image object specifying the image displayed in the column header. + + + + Gets or sets the alignment of the column header’s image. + + A enumeration member which specifies the image’s alignment. + + + + Gets or sets the index of the image from the TreeList.ColumnsImageList collection displayed in the column header. + + An integer value specifying the image by its zero-based index in the source collection. -1 to not display an image. + + + + Provides access to settings that allow you to set up raster and vector icons for this . + + An DevExpress.XtraTreeList.Columns.TreeListColumnImageOptions object that stores image-related options. + + + + Gets the source of images that can be displayed within column headers. + + An object which represents the source of the images that can be displayed within column headers. + + + + Gets whether this column displays the node expand/collapse buttons. + + true if this column displays the node expand/collapse buttons; otherwise, false. + + + + Gets the maximum column width. + + An value that determines the maximum column width. + + + + Gets the minimum column width. + + An Integer value that determines the minimum column width. + + + + Provides access to the column’s recently used filters. + + A DevExpress.XtraTreeList.TreeListFilterInfoCollection object that stores the recently used filters for the column. + + + + Gets or sets the column’s name. + + A string value representing the column name. + + + + Provides access to the column’s options. + + A object which contains the column’s options. + + + + Provides access to settings applied to the Edit Form. + + An object that contains settings applied to the Edit Form. + + + + Provides access to the column’s filter options. + + An object that contains the column’s filter options. + + + + Gets or set a column’s parent band. + + A value that specifies the column’s parent band. + + + + Gets a value indicating whether data within a column can be edited. + + true if column data cannot be changed; otherwise, false. + + + + Gets the repository item that actually specifies the column’s editor. + + A descendant that specifies the actual column’s editor. + + + + Gets or sets the column header height, in logical rows. This property is in effect when columns can be arranged one under another in Banded mode. + + The height of the column header, in logical rows. + + + + Specifies the type of summary calculated against child nodes for every parent node in the current column. + + A enumerator value. + + + + Gets or sets the format to display the TreeListColumn.RowFooterSummary. + + A string that specifies the format applied to the TreeListColumn.RowFooterSummary. + + + + Gets or sets the vertical position of a banded column. + + The zero-based index that specifies the band row where the column header is displayed. + + + + Gets or sets the width, in pixels, of the column separator (grid vertical lines that visually separate this column from other columns). + + An integer value that specifies the column separator width, in pixels. + + + + Gets or sets a value that specifies which column cells display editor buttons. + + A value that specifies which column cells display editor buttons. + + + + Gets or sets whether an end-user can open an Expression Editor for the current unbound column, using a context menu. + + true if an end-user can open an Expression Editor for the current unbound column, using a context menu; otherwise, false. + + + + Gets the index of the column in the sorting columns list. + + An integer value representing the zero-based index of the column within the sorting columns list. + + + + Gets or sets how the column’s data is sorted when sorting is applied. + + A value specifying how the column’s data is sorted in sort mode. + + + + Gets or sets the column’s sort order. + + A enumeration value specifying the column’s sort order. + + + + Gets or sets the name of the style for the current column. + + A string representing the name of the style set for the current column. + + + + Specifies the type of the summary to calculate against all nodes. + + A enumerator value that specifies the summary type applied. + + + + Gets or sets the format to display the TreeListColumn.SummaryFooter. + + A string that specifies the format applied to the TreeListColumn.SummaryFooter. + + + + Gets or sets the column’s associated data. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Serializable System.Object properties that contain custom type values are not (de)serialized automatically. Review the following help topic for information on how to (de)serialize custom type values: Safe Deserialization. + + An object representing data associated with the column. + + + + Gets or sets a custom tooltip for the column. + + A string representing a custom tooltip for the column. + + + + Gets the column’s caption. + + A string that specifies the column’s caption. + + + + Obtains the control to which a column belongs. + + A control to which a column belongs. + + + + Allows you to make the column unbound, and specify the type of data it stores. + + The type of data to store in the unbound column. + + + + For internal use. + + + + + Gets or sets an expression used to evaluate values for the current unbound column. + + A that specifies an expression used to evaluate values for this column. + + + + Specifies whether this column is unbound, and if so, the type of data it stores. + + A value that specifies the column’s data type and binding mode. + + + + Gets or sets whether the column is visible. + + true if the column is visible; otherwise, false. + + + + Gets or sets the position in the Tree List where the current column is displayed. + + An Integer value that specifies the position of the current column in the Tree List. + + + + Gets the visible width of the column. + + An integer value representing the visible column width. + + + + Gets or sets the column width in pixels. + + An integer value representing the column width in pixels. + + + + Represents a column collection in the Tree List control. + + + + + Creates a new object. + + A object to which a new column collection belongs. + + + + Creates a new column and appends it to the end of the collection. + + A object representing the new column. + + + + Adds the specified column to the end of the collection. + + An object that specifies the column to be added. + A value that specifies the position into which the column was inserted. + + + + Creates a new column which is bound to the specified field and appends it to the collection. + + A value that specifies the name of the data field to bind the created column to. + A object which represents the new column. + + + + Adds an array of columns to the end of the collection. + + An array of objects. + + + + Adds a new column, binding it to the specified field and making this column visible. + + A string that specifies the name of the field to which to bind the created column. This value is assigned to the TreeListColumn.FieldName property. + The created column. + + + + Copies the current collection’s elements to the collection specified. + + A object representing the column collection into which columns are copied. + + + + Removes all elements from the collection. + + + + + Fires when changes are made to the column collection. + + + + + Returns a column with the field name specified. + + A value that specifies the name of the field to which the column is bound. + A object which represents the column bound to the specified field. null (Nothing in Visual Basic) if the collection has no columns bound to the field. + + + + Returns a column specified by its name. + + A string value specifying the column’s name. + A object which represents the column with the specified name. null (Nothing in Visual Basic) if the collection doesn’t contain the column with the specified name. + + + + Gets the number of elements actually contained in the collection. + + An integer value that specifies the number of elements actually contained in the collection. + + + + Executes the specified action on each element of the collection. + + The delegate to execute on each element of the collection. + + + + Returns an enumerator that iterates through the collection. + + An IEnumerator<TreeListColumn> object that can be used to iterate through the collection. + + + + Returns the specified column’s position within the collection. + + A object to locate in the collection. + A zero-based integer representing the column’s position within the collection. -1 if the column doesn’t belong to the collection. + + + + Creates a new column and adds it to the collection at the specified position. + + A zero-based integer specifying the new column’s position within the collection. If negative, the column is inserted as the first element. If it exceeds the last available index, the column is appended to the end of collection. + A object representing the column inserted. + + + + Provides indexed access to individual columns. + + A zero-based integer identifying the desired column’s position within the collection. + A object representing the column at the specified position. null (Nothing in Visual Basic) if the collection doesn’t contain a column at the specified position. + + + + Gets the column bound to the specified field. + + A string value specifying the column’s bound field name. + A object representing the column bound to the specified field. null (Nothing in Visual Basic) if the collection doesn’t contain a column bound to the specified field. + + + + Removes a column from the collection. + + A object representing the column to remove. + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + + + + Gets the control that owns the collection. + + A object representing the Tree List that owns the column collection. + + + + Provides access to band options. + + + + + Initializes a new instance of a class. + + + + + Specifies whether the band can be moved by dragging its header. + + true if the band can be moved to a new position; otherwise, false. + + + + Specifies whether the band can be resized by dragging the right edge of its header; + + true if the band can be resized; otherwise, false. + + + + Copies all settings from the options object passed as a parameter. + + An object whose settings are assigned to the current object. + + + + Specifies whether the band’s width remains fixed when the ‘s auto width feature is enabled and the Tree List is resized. + + true if the band’s width remains fixed; otherwise, false. + + + + Specifies whether the band’s header is displayed in the Customization Form when the band is hidden. + + true, the band’s header is displayed in the Customization Form when the band is invisible; otherwise, false. + + + + Provides a treelist column’s general options. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Specifies if users can edit column values in tree list cells (inplace edit mode). + + true to allow users to edit cell values; otherwise, false. + + + + Gets or sets whether end-users can move focus to the column using either the mouse or keyboard. + + true if end-users can move focus to the column using either the mouse or keyboard; otherwise, false. + + + + Gets or sets whether end-users can drag the column’s header. + + true if end-users can drag the column’s header; otherwise, false. + + + + Gets or sets whether end-users can drag the column’s header to the Customization Form. + + true to allow end-users to drag the column’s header to the Customization Form; otherwise, false. + + + + Gets or sets whether end-users can drag the column header’s right edge to change the column’s width. + + true if end-users can change the column’s width; otherwise, false. + + + + Gets or sets whether end-users can sort data by the column’s values. + + true if end-users can sort data by the column’s values; otherwise, false. + + + + Copies all the settings from the options object passed as the parameter to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the column’s width remains the same when the column’s auto width feature is enabled. + + true if the column’s width remains the same when the column’s auto width feature is enabled; otherwise, false. + + + + Gets or sets whether a column is included in the print/export output. + + A value that specifies whether a column is included in the print/export output. + + + + Gets or sets whether end-users are prevented from editing the column’s cell values. + + true if end-users are prevented from modifying the column’s cell values; otherwise, false. + + + + Gets or sets whether the column’s header is displayed within the Customization Form when the column is hidden. + + true if the column’s header is displayed within the Customization Form when the column is hidden; otherwise, false. + + + + Gets or sets whether the current column is available in the field list in the Expression Editor. + + true if the current column is available in the field list in the Expression Editor; otherwise, false. + + + + Represents a set of options that specify an editor for a column in the Edit Form. + + + + + Initializes a new instance of the class. + + + + + Assigns the specified object’s property values to the current object’s corresponding properties. + + The object whose property values to assign to the current object’s corresponding properties. + + + + Gets or sets the caption for the editor that corresponds to the current column in the Edit Form. + + A string value that specifies the caption for the editor that corresponds to the current column in the Edit Form. + + + + Gets or sets whether the caption is located at the editor’s near edge, over the editor, or hidden. + + A value that specifies whether the caption is located at the editor’s near edge, over the editor, or hidden. + + + + Gets or sets the number of layout columns that the editor occupies. + + An integer value that specifies the number of layout columns that the editor occupies. + + + + Gets or sets the number of layout rows that the editor occupies. + + An integer value that specifies the number of layout rows that the editor occupies. + + + + Gets or sets whether the editor starts a new row in the layout. + + true if the editor starts a new row in the layout; otherwise, false. + + + + Gets or sets whether the number of layout columns and rows that the editor occupies depend on the editor type. + + true if the number of layout columns and rows that the editor occupies depend on the editor type; otherwise, false. + + + + Gets or sets whether the editor for this column is displayed in the Edit Form. + + true if the editor for this column is displayed in the Edit Form; otherwise, false. + + + + Gets or sets the editor’s position number in the layout. If set to 0, the editor is displayed according to its position number in the tree list. + + An integer value that specifies the editor’s position number in the layout. + + + + Contains a treelist column’s filter options. + + + + + Initializes a new instance of the class. + + A object specifying the column associated with the options being created. + + + + Gets or sets whether the column’s values can be filtered using the Automatic Filtering Row. + + true if the column’s values can be filtered using the automatic filtering row; otherwise, false. + + + + Gets or sets whether users can filter data against this column using the pop-up filter menu and filter panel. + + true if an end-user can filter against the current column using the filter dropdown; otherwise, false. + + + + Copies the settings from the object passed as the parameter. + + An object whose settings are copied to the current object. + + + + Gets or sets the type of the comparison operator used to create filter conditions for the current column via the Automatic Filtering Row. + + An value that determines the type of the comparison operator used to create filter conditions for the current column via the auto filter row. + + + + Gets or sets whether the TreeListColumn.FieldNameSort or TreeListColumn.FieldName property specifies the data source field that provides values for the pop-up filter menu. + + True to use the property to provide values for the pop-up filter menu; Default or False to use the property. + + + + Gets or sets whether pop-up filter menus are displayed in the Excel or Classic style. + + A value that specifies whether pop-up filter menus are displayed in the Excel or Classic style. + + + + Gets or sets whether the column’s filter condition is updated as soon as an end-user modifies the contents of the auto filter row‘s cell. + + true if the column’s filter condition is updated each time an end-user modifies the contents of the auto filter row’s cell; otherwise, false. + + + + Gets or sets whether a filter condition selected in the pop-up filter menu‘s calendar applies immediately. + + Default or True if a filter condition applies immediately; otherwise, False. + + + + Gets or sets whether filter conditions immediately apply to data, or only when the Excel-style Filter Dropdown closes. + + True or Default, if filter conditions immediately apply to data; otherwise, False. + + + + Gets or sets whether date-time values are arranged in an outline view or a list in the Excel style pop-up filter menus. + + An DevExpress.XtraTreeList.ExcelFilterDateTimeValuesTabFilterType enumeration value that specifies whether date-time values are arranged in an outline view or a list in the Excel style pop-up filter menus. + + + + Gets or sets whether the Values or Filters tab is activated when the Excel style pop-up filter menu opens. + + An DevExpress.XtraTreeList.ExcelFilterDefaultTab enumeration value that specifies whether the Values or Filters tab is activated when the Excel style pop-up filter menu opens. If Default, the activated tab depends or the column’s data type. + + + + Gets or sets whether to show relational operators (Equals, GreaterThan, etc.) for enumeration values in the Excel style pop-up filter menus. + + An DevExpress.XtraTreeList.ExcelFilterEnumFilters enumeration value that specifies whether to show relational operators (Equals, GreaterThan, etc.) for enumeration values in the Excel style pop-up filter menus. + + + + Gets or sets data field (column) names separated by the comma, semicolon, space or tab character by which filter values are grouped in the column’s filter menu. + + A value specifying data field names separated by the comma, semicolon, space or tab character by which filter values are grouped in the column’s filter menu. + + + + Gets or sets whether numeric values are arranged in a list or a range in the Excel style pop-up filter menus. + + An DevExpress.XtraTreeList.ExcelFilterNumericValuesTabFilterType enumeration value that specifies whether numeric values are arranged in a list or a range in the Excel style pop-up filter menus. + + + + Gets or sets whether to show pattern-matching (e.g., Is Like) and relational (e.g., Greater Than) operators for string values in the Excel style pop-up filter menus. + + AllFilters, to show relational and pattern-matching operators in the Excel style pop-up filter menus; otherwise, TextFilters or Default. + + + + Resets all options to their default values. + + + + + Gets or sets whether the value list and value checklist in the pop-up filter menu contain the (Blanks) and (Non Blanks) filter conditions. + + True if the (Blanks) and (Non Blanks) filter conditions are displayed; False if not. Default if the visibility depends on whether the current column contains Null or DBNull values. + + + + Gets or sets whether the calendar in the pop-up filter menu contains the Show Empty filter condition. + + true if the null-value filter condition is displayed; otherwise, false. + + + + Provides access to the Find Panel‘s view and behavior settings. + + + + + Initializes a new instance of the class. + + A object specifying the tree list control associated with the options being created. + + + + Gets or sets whether the Find Panel can be invoked by an end-user. + + true if the Find Panel can be invoked by an end-user; otherwise, false. + + + + Gets or sets whether or not end-users can utilize incremental search to find required records. + + true if end-users can utilize incremental search to find required records; otherwise, false. + + + + Gets or sets whether the Find Panel keeps the history of recently used search items. Users can access and re-apply search items from a dropdown list. + + true, to allow users to apply recently used search items; otherwise, false. + + + + Gets or sets whether the Find Panel is always visible. + + true if the Find Panel is always visible; otherwise, false. + + + + Copies all the settings of the options object passed as this method’s parameter to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether records that do not match a query in the find panel are hidden. + + A enumeration value that specifies whether records that do not match the query are hidden. + + + + Gets or sets whether the Find Panel’s search (filter) string is cleared when the Find Panel is hidden. + + true if the Find Panel’s search string is cleared on hiding the control; otherwise, false. + + + + Gets or sets the operator (Starts With, Contains, etc.) used to evaluate words in cells against keywords in the Find Panel. + + Specifies the filter condition. + + + + Returns ‘*’ which means that the search is performed against all visible columns. + + + + + Gets or sets whether or not the TreeList should expand collapsed nodes that contain records which match the text an end-user types. + + true if the TreeList should expand collapsed nodes that contain matching records; otherwise, false. + + + + Gets or sets the delay in milliseconds, after which a data search is initiated (if automatic search mode is active). + + An integer that specifies the delay in milliseconds, after which a data search is initiated. + + + + Gets or sets the field names against which searches are performed by the Find Panel. + + A string specifying the field names against which searches are performed. + + + + Gets or sets whether data searches start automatically, or must be started manually. + + The value that specifies whether a search starts automatically, or must be started manually. + + + + Gets or sets the text displayed grayed out when the search box is empty. + + The text displayed grayed out when the search box is empty. + + + + Gets or sets whether the search string is highlighted within located records. + + true if the search string is highlighted within located records; otherwise, false. + + + + Gets or sets whether a search query in the Find Panel is treated as a whole, or as separate keywords for a logical conjunction or disjunction. + + A FindPanelParserKind enumeration value. + + + + Gets or sets whether the Clear button is displayed within the Find Panel. + + true if the Clear button is displayed within the Find Panel; otherwise, false. + + + + Gets or sets whether the close (‘x’) button is displayed within the Find Panel. + + true if the close (‘x’) button is displayed within the Find Panel; otherwise, false. + + + + Gets or sets whether the Find button is displayed within the Find Panel. + + true if the Find button is displayed within the Find Panel; otherwise, false. + + + + Gets or sets whether the Previous and Next buttons are displayed allowing users to navigate through search results. + + true if the navigation buttons are displayed; otherwise, false. + + + + Provides data for the TreeList.CompareNodeValues event. + + + + + Creates a new object. + + A object representing the node containing the first value involved in the comparison. This value is assigned to the CompareNodeValuesEventArgs.Node1 property. + A object representing the node that contains the second value involved in the comparison. This value is assigned to the CompareNodeValuesEventArgs.Node2 property. + An object representing the first value involved in the comparison. This value is assigned to the CompareNodeValuesEventArgs.NodeValue1 property. + An object representing the second value involved in the comparison. This value is assigned to the CompareNodeValuesEventArgs.NodeValue2 property. + A object representing the column against whose values the data will be sorted. This value is assigned to the CompareNodeValuesEventArgs.Column property. + A enumeration member representing the sort order to be applied. This value is assigned to the CompareNodeValuesEventArgs.SortOrder property. + An integer value representing the comparison result. This value is assigned to the CompareNodeValuesEventArgs.Result property. + + + + Gets the column against whose values sorting is performed. + + A object representing the column against whose values data is being sorted. + + + + Gets the node containing the first value involved in comparison. + + A object representing the node containing the first value involved in comparison. + + + + Gets the node containing the second value involved in comparison. + + A object representing the node that contains the second value involved in comparison. + + + + Gets the first value involved in comparison. + + An object representing the first value involved in comparison. + + + + Gets the second value involved in comparison. + + An object representing the second value involved in comparison. + + + + Gets or sets a comparison result. + + An integer value representing the comparison result. + + + + Gets the sort order applied to the column whose values are going to be compared. + + A enumeration member representing the sort order applied. + + + + Represents a method that will handle the TreeList.CompareNodeValues event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.CreateCustomNode event. + + + + + Initializes a new instance of the class with the specified settings. + + A zero-based integer specifying the unique identifier of the created node. This value is assigned to the CreateCustomNodeEventArgs.NodeID property. + A collection which owns the created node. This value is assigned to the CreateCustomNodeEventArgs.Owner property. + A custom object to be associated with the created node. This value is assigned to the CreateCustomNodeEventArgs.Tag property. + + + + Gets or sets a value which represents the created node. + + A descendant which represents the created node. + + + + Gets the node’s unique identifier. + + A zero-based integer specifying the unique identifier of the created node. + + + + Gets the collection of nodes which owns the created node. + + A collection which owns the created node. + + + + Gets the data associated with the Tree List node via the constructor. + + An object containing custom information associated with the Tree List node. + + + + Represents a method that will handle the TreeList.CreateCustomNode event. + + The event sender. Identifies the Tree List that raised the event. + A object that contains event data. + + + + Provides data for the TreeList.CustomDrawColumnHeader event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A DevExpress.Utils.Drawing.HeaderObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.XtraTreeList.ViewInfo.ColumnInfo object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets or sets the text displayed within the painted column header. + + A string value representing the painted column header’s text. An empty string if the column button or the space not occupied by column headers is painted. + + + + Gets the rectangle where the column caption is intended to be drawn. + + A System.Drawing.Rectangle structure specifying the bounding rectangle of the header’s text. + + + + Gets the column whose header is painted. + + A object representing the column whose header is painted. null (Nothing in Visual Basic) if the column button or the space not occupied by column headers is currently painted. + + + + Gets an object containing information about the painted element. + + A DevExpress.XtraTreeList.ViewInfo.ColumnInfo object providing information about the painted element. + + + + Gets a value indicating the type of element to be painted. + + A enumeration value indicating the type of element to be painted. + + + + Gets a value indicating whether the painted column header is hot tracked. + + true if the painted column header is hot tracked; otherwise false. + + + + Gets a value indicating whether the painted element is pressed. + + true if the painted element is pressed by an end-user; otherwise false. + + + + Gets the rectangle where the image indicating sort order is intended to be drawn. + + A System.Drawing.Rectangle structure specifying the sort order image’s bounding rectangle. + + + + Represents a method that will handle the TreeList.CustomDrawColumnHeader event. + + The event sender (typically, the control). + A object that contains the event data. + + + + Provides data for the TreeList.CustomDrawEmptyArea event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object providing a means for painting. This value is assigned to the CustomDrawEventArgs.Graphics property. + A structure which represents the bounding rectangle occupied by the empty rows. This value is assigned to the CustomDrawEmptyAreaEventArgs.EmptyRows property. + An array of rectangles that specify the empty area. This value is assigned to the CustomDrawEmptyAreaEventArgs.EmptyRectangles property. + A DevExpress.Utils.Drawing.ObjectInfoArgs object providing information about the painted element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets the blank column’s bounding rectangle. + + A structure specifying the drawing area under the blank column header. + + + + Gets the region which is occupied by the empty area. + + A object which represents the interior of the empty area. + + + + Gets the array of rectangles that specify the empty area. + + An array of rectangles that specify the empty area. + + + + Gets the bounding rectangle occupied by the empty rows. + + A structure which represents the bounding rectangle occupied by the empty rows. + + + + Represents a method that will handle the TreeList.CustomDrawEmptyArea event. + + The event sender (the object which raised the event). + A object that contains event data. + + + + Provides basic data required to perform custom painting of an element. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified CustomDrawEventArgs.Painter property. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A structure which represents the painted element’s bounding rectangle. This value is assigned to the CustomDrawEventArgs.Bounds property. + An object which specifies the painted element’s appearance settings. This value is assigned to the CustomDrawEventArgs.Appearance property. + An DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A Boolean value that specifies whether the TreeList’s elements are aligned to support locales using right-to-left fonts. This value is assigned to the CustomDrawEventArgs.IsRightToLeft property. + + + + Initializes a new instance of the class with the specified CustomDrawEventArgs.Painter property. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A structure which represents the painted element’s bounding rectangle. This value is assigned to the CustomDrawEventArgs.Bounds property. + An object which specifies the painted element’s appearance settings. This value is assigned to the CustomDrawEventArgs.Appearance property. + An DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A structure which represents the painted element’s bounding rectangle. This value is assigned to the CustomDrawEventArgs.Bounds property. + An object which specifies the painted element’s appearance settings. This value is assigned to the CustomDrawEventArgs.Appearance property. + + + + Gets the painted element’s appearance settings. + + A object specifying the painted element’s appearance settings. + + + + Gets the painted element’s bounding rectangle. + + A System.Drawing.Rectangle structure specifying the boundaries of the painted element. + + + + Gets an object specifying the storage for the most used pens, fonts and brushes. + + A object. + + + + Performs default painting of an element. + + + + + Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements. + + A template to draw. + The object that transfers mouse events from a control to a template instance. This allows you to switch visual states (regular, hovered, pressed, and others) of template elements. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Paints the required HTML template inside an element that raised this event. + + A template to draw. + Sets up required properties of the DxHtmlPainterArgs object. + + + + Gets an object used to paint. + + A System.Drawing.Graphics object used to paint. + + + + Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. + + true if the default element painting is not required; otherwise, false. + + + + Gets a value indicating whether the TreeList’s elements are aligned to support locales using right-to-left fonts. + + true if the TreeList’s elements are aligned to support locales using right-to-left fonts; otherwise, false. + + + + Gets an object containing information about the painted element. + + An ObjectInfoArgs object providing information about the painted element. + + + + Gets the painter object that provides the default element’s painting mechanism. + + An ObjectPainter descendant providing the default painting mechanism for the painted element. + + + + Provides data for the TreeList.CustomDrawFooterCell event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A DevExpress.XtraTreeList.FooterItem object that stores the internal information about the footer cell being processed. + An DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.Utils.Drawing.FooterCellInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets an object containing information about the painted element. + + A DevExpress.Utils.Drawing.FooterCellInfoArgs object providing information about the painted element. + + + + Gets a column whose footer cell is painted. + + A object representing the column whose footer cell is painted. + + + + Gets the type of summary whose value is displayed within the painted cell. + + A enumeration value specifying the type of summary whose value is displayed within the painted cell. + + + + Gets or sets the text intended to be displayed within the painted footer cell. + + A string value specifying the text to be displayed within the painted footer cell (a string representation of the resulting summary value). An empty string if summary is not applied to a column whose footer cell is being painted. + + + + Represents a method that will handle the TreeList.CustomDrawFooterCell event. + + The event sender (typically the control). + A that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawFooter event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + An DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.XtraTreeList.ViewInfo.SummaryFooterInfo object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets an object containing information about the painted element. + + A DevExpress.XtraTreeList.ViewInfo.SummaryFooterInfo object providing information about the painted element. + + + + Represents a method that will handle the TreeList.CustomDrawFooter event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawNodeButton event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A object specifying the node being processed. This value is assigned to the DevExpress.XtraTreeList.CustomDrawNodeEventArgs.Node property. + A DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.Utils.Drawing.OpenCloseButtonInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets or sets whether to draw a background that detaches the button from the tree hierarchy lines. + + true, to draw a background that detaches the button from the tree hierarchy lines; otherwise, false. + + + + Gets a value indicating whether the painted button’s corresponding node is expanded. + + true if the painted button’s corresponding node is expanded; otherwise false. + + + + Represents a method that will handle the TreeList.CustomDrawNodeButton event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawNodeCell event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A DevExpress.XtraTreeList.ViewInfo.CellInfo object that stores the internal information about the processing cell. + A DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.Utils.Drawing.StyleObjectInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + true if the cell is focused; otherwise, false. This value is assigned to the CustomDrawNodeCellEventArgs.Focused property. + + + + Gets the painted cell’s display text. + + A string value representing the painted cell’s display text. + + + + Gets the painted cell’s value. + + An object representing the painted cell’s value. + + + + Gets the painted cell’s column. + + A object representing the column that contains the painted cell. + + + + Gets the editor’s painter object used to paint a cell. + + A BaseEditPainter object providing a painting mechanism for the painted editor. + + + + Gets the editor’s view information. + + A DevExpress.XtraEditors.ViewInfo.BaseEditViewInfo object providing view information on the painted cell’s editor. + + + + Gets a value indicating whether the painted cell has focus. + + true if the painted cell has focus; otherwise. false. + + + + Represents a method that will handle the TreeList.CustomDrawNodeCell event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawNodeImages event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A object specifying the node being precessed. This value is assigned to the DevExpress.XtraTreeList.CustomDrawEventArgs.Node property. + An integer value representing the zero-based index of the image displayed within the node when it is focused. This value is assigned to the CustomDrawNodeImagesEventArgs.SelectImageIndex property. + An integer value representing the node state’s image index. This value is assigned to the CustomDrawNodeImagesEventArgs.StateImageIndex property. + A System.Drawing.Rectangle structure representing the bounding rectangle of the select image. This value is assigned to the CustomDrawNodeImagesEventArgs.SelectRect property. + A System.Drawing.Rectangle structure that represents the state image’s bounding rectangle. This value is assigned to the CustomDrawNodeImagesEventArgs.StateRect property. + A System.Drawing.Point structure that represents the top-left point of the selected image. This value is assigned to the CustomDrawNodeImagesEventArgs.SelectImageLocation property. + A System.Drawing.Point structure specifying the top-left corner of the state image. This value is assigned to the CustomDrawNodeImagesEventArgs.StateImageLocation property. + A DevExpress.Utils.Drawing.StyleObjectInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets or sets the index of the image displayed within the painted node when it is focused. + + An integer value representing the zero-based index of the image displayed within the node when it is focused. + + + + Gets the location of the select image’s top-left corner. + + A System.Drawing.Point structure that represents the top-left point of the select image. + + + + Gets the bounding rectangle of the select image. + + A System.Drawing.Rectangle structure representing the bounding rectangle of the select image. + + + + Gets or sets the index of the state image displayed within the node. + + An integer value representing the node’s state image’s index. + + + + Gets the location of the state image’s top-left corner. + + A System.Drawing.Point structure specifying the top-left corner of the state image. + + + + Gets the bounding rectangle of the state image. + + A System.Drawing.Rectangle structure that represents the state image’s bounding rectangle. + + + + Represents a method that will handle the TreeList.CustomDrawNodeImages event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawNodeIndicator event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A object specifying the node being processed. This value is assigned to the DevExpress.XtraTreeList.CustomDrawEventArgs.Node property. + A DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.Utils.Drawing.IndicatorObjectInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets or sets the index of an image to be painted in the indicator cell. + + The index of an image to be painted in the indicator cell. -1 if no image is displayed. + + + + Gets an object containing information about the painted element. + + A DevExpress.Utils.Drawing.IndicatorObjectInfoArgs object providing information about the painted element. + + + + Gets a value indicating whether the painted indicator cell corresponds to a node or to a row footer. + + true if the painted cell corresponds to a node; otherwise false. + + + + Represents a method that will handle the TreeList.CustomDrawNodeIndicator event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawNodePreview event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets the painted element’s appearance settings. + + A object specifying the painted element’s appearance settings. + + + + Gets or sets the painted preview section’s text. + + A string value representing the text of the preview section being painted. + + + + Gets the content bounds of the preview section. + + A bounding rectangle. + + + + Represents a method that will handle the TreeList.CustomDrawNodePreview event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawRowFooterCell event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A DevExpress.XtraTreeList.FooterItem object that stores the internal information about the footer cell being processed. + A object specifying the node being precessed. This value is assigned to the DevExpress.XtraTreeList.CustomDrawEventArgs.Node property. + A DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.Utils.Drawing.FooterCellInfoArgs object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets the node for whose children the row footer is displayed. + + A object specifying the node for whose children the row footer is displayed. + + + + Represents a method that will handle the TreeList.CustomDrawRowFooterCell event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomDrawRowFooter event. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A object which specifies the storage for the most used pens, fonts and brushes. This value is assigned to the CustomDrawEventArgs.Cache property. + A DevExpress.Utils.Drawing.ObjectPainter object that provides facilities for painting an element using the default mechanism. This value is assigned to the CustomDrawEventArgs.Painter property. + A DevExpress.XtraTreeList.ViewInfo.RowFooterInfo object that provides information used to paint an element. This value is assigned to the CustomDrawObjectEventArgs.Info property. + + + + Gets an object containing information about the painted element. + + A DevExpress.XtraTreeList.ViewInfo.RowFooterInfo object providing information about the painted element. + + + + Gets the node for whose children the painted row footer is displayed. + + A object representing the node for whose children the row footer is displayed. + + + + Represents a method that will handle the TreeList.CustomDrawRowFooter event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.CustomizeNewNodeFromOuterData event. + + + + + Initializes a new instance of the class. + + The node (from another control) being dragged. This value is assigned to the CustomizeNewNodeFromOuterDataEventArgs.SourceNode property. + The collection of sibling nodes relative to which the sourceNode is dropped. This value is assigned to the CustomizeNewNodeFromOuterDataEventArgs.DestinationNodes property. + The dictionary that contains data to initialize a new node. This value is assigned to the CustomizeNewNodeFromOuterDataEventArgs.NewData property. + + + + Gets the node onto which (or relative to which) the CustomizeNewNodeFromOuterDataEventArgs.SourceNode is dropped. + + The node relative to which the dragged node is dropped. + + + + Gets the collection of sibling nodes relative to which the CustomizeNewNodeFromOuterDataEventArgs.SourceNode is dropped. + + The sibling nodes relative to which the dragged node is dropped. + + + + Gets or sets whether you perform all the required actions manually and no default processing is required. + + true if no default processing is required; false if default processing will be performed after your event handler execution. + + + + Provides access to the dictionary that contains data to initialize a new node. + + The dictionary that contains data to initialize a new node. + + + + Gets the node (from another TreeList control) being dragged. + + The node (from another TreeList control) being dragged. + + + + Represents a method that will handle the TreeList.CustomizeNewNodeFromOuterData event. + + The control that fires the event. + Contains event data. + + + + Provides data for the TreeList.CustomRowFilter event. + + + + + Initializes a new instance of the class. + + The processed . This value is assigned to the Node property. + true if the node fits the applied filter; otherwise, false. This value is assigned to the IsFitDefaultFilter property. + + + + Gets a value of a specific column in the processed . + + A object that identifies a column. + The value of a specific column. + + + + Gets an object representing a data row in the underlying data source that corresponds to the processed . + + An object representing a data row in the underlying data source that corresponds to the processed . + + + + Gets whether the processed is visible. + + true if the processed is visible; otherwise, false. + + + + Contains classes that encapsulate data processing operations. + + + + + Enumerates data types that columns can have in unbound mode. + + + + + Indicates that the column contains Boolean values (the type). + + + + + Indicates that the column is bound to a field in the control’s underlying data source. The type of data this column contains is determined by the bound field. + + + + + Indicates that the column contains date-time values (the type). + + + + + Indicates that the column contains decimal values (the type). + + + + + Indicates that the column contains integer (16, 32, 64), Byte, SByte, or UInt (16, 32, 64) values. + + + + + Indicates that the column contains values of any type. + + + + + Indicates that the column contains string values (the type). + + + + + Enumerates values that specify the location of the editor’s caption within the Edit Form. + + + + + Specifies the same location as EditFormColumnCaptionLocation.Near. + + + + + The caption is displayed on the left side of the editor (left-to-right layout); otherwise, the caption is displayed to the right of the editor (right-to-left layout). + + + + + Hides the caption. + + + + + The caption is located above the editor. + + + + + Provides data for the TreeList.EditFormHidden event. + + + + + Initializes a new class instance. + + An object that specifies the processed node. + An object that specifies the Edit Form’s root panel. + An object that specifies the collection of controls used to edit the processed data record. + A value that specifies the clicked button. + + + + Provides access to the collection of controls used to edit the processed data record. Controls are indexed by field names or tree list nodes. + + An object that specifies the collection of controls used to edit the processed data record. + + + + Gets the node for which the Edit From is closed. + + An object that specifies the processed node. + + + + Gets the Edit Form’s root panel. + + An object that specifies the Edit Form’s root panel. + + + + Gets the clicked button. + + A value that specifies the clicked button. + + + + Provides data for the TreeList.EditFormPrepared event. + + + + + Initializes a new class instance. + + An object that specifies the Edit Form. + An object that specifies the Edit Form’s root panel. + An object that specifies the processed node. + A collection of the Edit Form’s editors. + + + + Provides access to the collection of controls used to edit the processed data record. Controls are indexed by field names or tree list nodes. + + An object that specifies the collection of controls used to edit the processed data record. + + + + Provides access to the Edit Form. + + An object that specifies the Edit Form. + + + + Gets the processed node. + + An object that specifies the processed node. + + + + Gets the Edit Form’s root panel. + + An object that specifies the Edit Form’s root panel. + + + + Enumerates values that specify the button clicked in the Edit Form. + + + + + The Cancel button is clicked. + + + + + The Update button is clicked. + + + + + Provides data for the TreeList.EditFormShowing event. + + + + + Initializes a new class instance. + + An object that specifies the processed node. + + + + Gets or sets whether it is allowed to show the Edit Form. + + true if it is allowed to show the Edit Form; otherwise, false. + + + + Gets the node for which the Edit Form is about to be shown. + + An object that specifies the processed node. + + + + Represents a custom Edit Form in the Tree List. + + + + + Initializes a new class instance. + + + + + Returns the field name in the data source to which the specified editor is bound. + + An object that specifies the editor on a custom Edit Form. + The field name in the data source to which the specified editor is bound. + + + + Gets the editor’s property bound to the field in the data source. + + An object that specifies an editor on the Edit Form. + The editor’s property bound to the field in the data source. + + + + Binds the specified editor to the specified data source field. + + An object that specifies an editor on the custom Edit Form. + The field name in the data source to which the editor should be bound. + + + + Sets property name that is bound to the data source field. + + An object that specifies an editor on the Edit Form. + The property name that is bound to the data source field. + + + + Enumerates modes that specify whether to show only the filtered nodes or also show their parent and child nodes. + + + + + Equivalent to ‘ParentBranch’ mode for the control. Equivalent to ‘Matches’ mode for the control. + + + + + Shows nodes that match the filter along with the nodes’ parents and children (even if they do not fit the filter). + + + + + + The same as the ‘ParentBranch’ option. + + + + + Shows only those nodes that match the filter. If a node is collapsed, its children are hidden even if they match the current filter. Enable the TreeListOptionsFilter.ExpandNodesOnFiltering option to automatically expand collapsed nodes before filtration. + + + + + + Shows nodes that match the filter along with the nodes’ parents (even if they do not fit the filter). + + + + + + Shows nodes if they and all their parents match the filter. + + If a node fits the filter but any of its parents does not, the node is not displayed. + + + + + + The same as the ‘Matches’ option. + + + + + The same as the ‘ParentsMatch’ option. + + + + + Provides data for the TreeList.CustomRowFilter event + + + + + Initializes a new instance of the class. + + The object to initialize the Node property. + The object to initialize the IsFitDefaultFilter property. + + + + Gets or sets whether the event is handled and no default processing is required. + + A value that specifies whether the event is handled and no default processing is required. + + + + Gets whether the row matches the filter applied to the tree list. + + true if the row matches the tree list’s filter; otherwise, false + + + + Gets the currently processed node. + + The currently processed node. + + + + Provides data for the event. + + + + + Gets the processed tree list column. + + An object that specifies the processed tree list column. + + + + Gets the tree list that raised the event. + + An object that specifies the tree list that raised the event. + + + + Enumerates values that specify the pop-up filter menu style. + + + + + The menu contains a value checklist. Users can select multiple values simultaneously. + + + + + The menu contains a calendar with predefined date ranges. If there are no dates that fall into the specified range, the corresponding option is hidden. + + + + + The mode is inherited from the parent tree list. See the TreeList.OptionsFilter.ColumnFilterPopupMode property. If this property is set to Classic, the List or Date mode is enabled (depending on the data type). + + + + + The menu contains two tabs: a value checklist and data-specific predefined filters. + + + + + The menu contains a value list. A click on a value closes the menu. + + + + + Contains values that specify how data searching is initiated within specific controls. + + + + + A control starts searching data automatically, after a short delay. + + + + + This option is equivalent to Always. + + + + + A control starts searching data on clicking the Find button or pressing ENTER. + + + + + Provides data for the TreeList.FocusedColumnChanged event. + + + + + Creates an instance of the class. + + A object representing the currently focused column. null (Nothing in Visual Basic) if none of the columns is currently focused. This value is assigned to the ColumnChangedEventArgs.Column property. + A object representing the previously focused column. null (Nothing in Visual Basic) if none of the columns was previously focused. This value is assigned to the FocusedColumnChangedEventArgs.OldColumn property. + + + + Gets the previously focused column. + + A object representing the previously focused column. null (Nothing in Visual Basic) if none of the columns was previously focused. + + + + Represents a method that will handle the TreeList.FocusedColumnChanged event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.FocusedNodeChanged event. + + + + + Initializes a new class instance. + + The previous focused Tree List node. + The current focused Tree List node. + + + + Gets the previously focused Tree List node. + + The previously focused Tree List node. + + + + Represents a method that will handle the TreeList.FocusedNodeChanged event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.CustomNodeCellEdit event. + + + + + Creates an instance of the class. + + A object representing the column whose cell is processed. This value is assigned to the CellEventArgs.Column property. + A object representing the node whose cell is processed. This value is assigned to the NodeEventArgs.Node property. + A object representing the editor used to edit the processed cell’s values. This value is assigned to the GetCustomNodeCellEditEventArgs.RepositoryItem property. + + + + Gets or sets the editor assigned to the processed cell. + + A object representing the currently assigned editor. + + + + Represents a method that will handle the TreeList.CustomNodeCellEdit event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.NodeCellStyle event. + + + + + Initializes a new instance of the class. + + A object which represents the cell’s owning column. This value is assigned to the CellEventArgs.Column property. + A object which represents the node in which the processed cell resides. This value is assigned to the NodeEventArgs.Node property. + An object which specifies the cell’s appearance settings. This value is assigned to the GetCustomNodeCellStyleEventArgs.Appearance property. + + + + Gets the appearance settings used to paint the cell currently being processed. + + An object which provides the appearance settings used to paint the cell. + + + + Represents a method that will handle the TreeList.NodeCellStyle event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.GetCustomSummaryValue event. + + + + + Initializes a new class instance. + + The nodes collection to calculate a summary. + A Tree List column. + Determines the collection contained in the nodes parameter. + + + + Obtains the Tree List column used by the summary calculations. + + A Tree List column used by the summary calculations. + + + + Gets or sets a value to be displayed within a summary. + + An object representing the custom summary value. + + + + Gets a value indicating whether the total or group summary value is to be calculated. + + true, if the total summary value is to be calculated; false for the group summary. + + + + Gets the nodes collection for which to calculate a custom summary. + + The nodes collection for which to calculate a custom summary. + + + + Represents a method that will handle the TreeList.GetCustomSummaryValue event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.GetNodeDisplayValue event. + + + + + Initializes a new instance of the class. + + A object representing the column which owns the cell being processed. This value is assigned to the CellEventArgs.Column property. + A object which represents a Tree List node whose cell is being processed. This value is assigned to the NodeEventArgs.Node property. + + + + Gets or sets the value contained within the processed cell. + + An object representing the processed cell’s value. + + + + Represents a method that will handle the TreeList.GetNodeDisplayValue event. + + The event sender (typically the control). + A object that contains the event data. + + + + Provides data for the TreeList.GetPreviewText and TreeList.GetPrintPreviewText events. + + + + + Initializes a new class instance. + + A Tree List node. + Preview text. + + + + Gets or sets the preview text. + + The preview text. + + + + Represents a method that will handle the TreeList.GetPreviewText event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.GetSelectImage event. + + + + + Initializes a new class instance. + + A Tree List node. + The image index. + Indicates whether a node is focused. + + + + Gets or sets a value indicating whether a node is focused. + + true if a node is focused; otherwise, false. + + + + Represents a method that will handle the TreeList.GetSelectImage event of the class. + + The event source. + A class instance containing event data. + + + + Provides data for the TreeList.GetStateImage event. + + + + + Initializes a new class instance. + + A Tree List node. + The image index. + + + + Gets or sets the index of the node’s image in a source image list. + When handling the TreeList.GetStateImage event, the source of images is specified by the TreeList.StateImageList property. + When handling the TreeList.GetSelectImage event, the source of images is specified by the TreeList.SelectImageList property. + + An integer value representing the zero-based index of an image from a source image list. + + + + Represents a method that will handle the TreeList.GetStateImage event of the class. + + The event source. + A class instance containing event data. + + + + Lists values that identify the different elements of the Tree List control. + + + + + A point is over the Automatic Filtering Row. + + + + + A point is over a band header. + + + + + A point is over the band button. + + + + + A point is over a band edge. + + + + + A point is over the band panel. + + + + + A point is over the blank column header. + + + + + A point is over an expand button. + + + + + A point is over the Caption Panel. + + + + + A point is over a cell. + + + + + A point is over a column header. + + + + + A point is over the column button. + + + + + A point is over a column edge. + + + + + A point is over a Filter Button. + + + + + A point is over a column header panel‘s area not occupied by a column header, blank column header, filter button, column button, or a column edge. + + + + + A point is over the Customization Form. + + + + + A point is over the empty area. + + + + + A point is over the Filter Panel. + + + + + A point is over the check box displayed within in the Filter Panel and used to enable/disable the filter. + + + + + A point is over the Close Filter Button in the Filter Panel. + + + + + A point is over the ‘Edit Filter’ button displayed within the Filter Panel and used to invoke the Filter Editor. + + + + + A point is over the MRU Filter Button in the Filter Panel. + + + + + A point is over the filter string displayed within the Filter Panel. + + + + + The test point belongs to the left fixed line. + + + + + The test point belongs to the right fixed line. + + + + + The test point belongs to the Tree List’s horizontal scroll bar. + + + + + The test point belongs to a node’s check box. + + + + + A point is outside the Tree List control. + + + + + A point is over a node area not occupied by any of the node’s elements. + + + + + A point is over a row (group) footer. + + + + + A point is over an area that separates a row from its corresponding indicator cell. This value is returned only when the TreeListOptionsView.ShowIndentAsRowStyle option is enabled. Otherwise, an Empty value is returned when a point is over this area. + + + + + A point is over a node indicator cell. + + + + + A point is on a row indicator‘s edge. + + + + + A point is over a preview section. + + + + + A point is over a node’s select image. + + + + + A point is over a column separator. + + + + + A point is over a node’s state image. + + + + + A point is over the summary footer. + + + + + The test point belongs to the Tree List’s vertical scroll bar. + + + + + Provides data for the TreeList.InvalidNodeException event. + + + + + Creates a new object. + + A object representing the exception that caused the event. This value is assigned to the ExceptionEventArgs.Exception property. + A string value specifying the error description. This value is assigned to the ExceptionEventArgs.ErrorText property. + A object representing the node that failed validation. This value is assigned to the InvalidNodeExceptionEventArgs.Node property. + + + + Gets the node that failed validation. + + A object representing the node that failed validation. + + + + Represents a method that will handle the TreeList.InvalidNodeException event. + + The event sender (the object which raised the event). + A object that contains event data. + + + + Specifies the tree line style for the current control. + + + + + Sets the control tree line style to Dark. + + + + + + Sets the control tree line style to Large. + + + + + + Sets the control tree line style to Light. + + + + + + Hides tree lines. + + + + + + Sets the control tree line style to Percent50. + + + + + + Sets the control tree line style to Solid. + + + + + + Sets the control tree line style to Wide. + + + + + + Contains classes and enumerations that are intended to localize the User Interface of DevExpress WinForms Tree List. + + + + + A base class that provides necessary functionality for custom localizers of the Tree List control. + + + + + Initializes a new instance of the class with default settings. + + + + + Gets or sets a localizer object providing localization of the user interface at runtime. + + An descendant, used to localize the user interface at runtime. + + + + Returns a localizer object, which provides resources based on the thread’s language and regional settings (culture). + + An object representing resources based on the thread’s culture. + + + + Returns a localizer object, which provides resources based on the thread’s language and regional settings (culture). + + A object, which provides resources based on the thread’s culture. + + + + Contains the enumeration specifying the menu types available in the Tree List control. + + + + + Enumerates values that specify context menu types in the control. + + + + + The menu that allows the user to select a condition in the automatic filtering row. + + + + + The context menu invoked with a right click on a column header. + + + + + The context menu invoked with a right click on a node. + + + + + The context menu invoked with a right click on a group summary or total summary. + + + + + Corresponds to the user defined context menu. + + + + + Provides data for the TreeList.NodeChanged event. + + + + + Initializes a new instance of the class. + + A object representing the processed node. This value is assigned to the NodeEventArgs.Node property. + A object specifying the collection that contains the current node. This value is assigned to the NodeChangedEventArgs.NodeCollection property. + A enumeration member specifying the way the node has been changed. This value is assigned to the NodeChangedEventArgs.ChangeType property. + + + + Gets the way the node has been changed. + + A enumeration member specifying the way the node has been changed. + + + + Gets the collection that contains the current node. + + A object that specifies the collection that contains the current node. + + + + Represents a method that will handle the TreeList.NodeChanged event. + + The event sender (the object which raised the event). + A object that contains event data. + + + + Contains values indicating how the node has been changed. + + + + + A new node has been added to the Tree List’s TreeList.Nodes collection. This can be performed by calling the TreeListNodes.Add method. + + + + + The node’s TreeListNode.ChildrenCheckBoxStyle has changed. + + + + + The node’s TreeListNode.Checked property has been changed. + + + + + The node’s TreeListNode.Expanded property has been set to false. + + + + + The node’s TreeListNode.Expanded property has been set to true. + + + + + The node’s TreeListNode.HasChildren property has been changed. + + + + + The node’s TreeListNode.ImageIndex property has been changed. + + + + + A node has been removed from the Tree List’s TreeList.Nodes collection. This can be performed using the TreeListNodes.Remove method. + + + + + The node’s TreeListNode.SelectImageIndex property has been changed. + + + + + The node’s TreeListNode.StateImageIndex property has been changed. + + + + + The node’s TreeListNode.Tag property has been changed. + + + + + The corresponding user’s property has been changed. + + + + + The corresponding user’s property has been changed. + + + + + The corresponding user’s property has been changed. + + + + + Provides data for the TreeList.SelectImageClick and TreeList.StateImageClick events. + + + + + Creates an instance of the class. + + A object representing mouse event arguments. + A object representing the clicked node. + + + + Creates an instance of the class. + + A object representing the clicked node. + A System.Drawing.Point structure that contains the current mouse pointer position. + + + + Gets the row (node) being clicked. + + A object representing the row (node) being clicked. + + + + Gets the mouse pointer’s location. + + A structure that contains the current mouse pointer’s location. + + + + Represents a method that will handle the TreeList.StateImageClick and TreeList.SelectImageClick events. + + The event sender (typically the control). + A object that contains the event data. + + + + Provides data for the TreeList.AfterCollapse, TreeList.AfterExpand, TreeList.AfterDragNode and TreeList.AfterFocusNode events. + + + + + Initializes a new class instance. + + A Tree List node. + + + + Gets the current Tree List node. + + A object that specifies the current Tree List node. + + + + Represents a method that will handle events that require a node as the parameter. + + The sender of an event. + A object that contains event related data. + + + + Contains classes that implement nodes for the Tree List control. + + A tree node is similar to a row in the XtraGrid. Nodes are organized in a hierarchical structure using parent-child relationships. + The Tree List control has a TreeList.Nodes property which supports the node collection for the Tree List. + By using class methods, you can access individual column elements. + + + + + Contains classes that can be used to perform custom operations against nodes of the Tree List control without having to write recursive code. + + + + + Enables you to perform specified operations over nodes from the predefined set. + + + + + Gets the collection of all nodes. + + An <,> object specifying the collection of all nodes. + + + + Performs an operation across all Tree List nodes that fit the specific criteria. Defines a separate criteria to check whether or not this operation should be applied to child nodes as well. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the remaining nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation can be applied to the current node. + A Predicate<TreeListNode> delegate that determines whether or not the nodes iterator should try performing the execute operation on the current node’s children. + + + + Performs an operation across all Tree List nodes that fit the specific criteria. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the remaining nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation can be applied to the current node. + + + + Performs the specific operation across all Tree List nodes. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the remaining nodes. + + + + Performs the specific operation across all Tree List nodes. + + An Action<TreeListNode> delegate that performs an operation on nodes. + + + + Performs a specific operation on TreeList nodes. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A collection that stores nodes which should be exposed to the execute operation. + + + + Performs a specific operation on TreeList nodes. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the next node. + A collection that stores nodes which should be exposed to the execute operation. + + + + Performs a specific operation on TreeList nodes that fit the specific criteria. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the next node. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation can be applied to the current node. + A collection that stores nodes which should be exposed to the execute operation. + + + + Performs a specific operation on TreeList nodes that fit the specific criteria. Can also perform the same operation on child nodes owned by the processed nodes. + + An Action<TreeListNode> delegate that performs an operation on nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation should be applied to the remaining nodes. + A Predicate<TreeListNode> delegate that checks whether or not the execute operation can be applied to the current node. + A Predicate<TreeListNode> delegate that determines whether or not the nodes iterator should try performing the execute operation on the current node’s children. + A collection that stores nodes which should be exposed to the execute operation. + + + + Performs the specified operation over the predefined set of nodes and their children. + + A descendant representing the operation to be performed. + A object representing the collection of nodes across which the operation is performed. + + + + Performs the specified method over the predefined set of nodes and their children. + + A TreeListOperationDelegate object that represents the method to be called for the specified nodes. + A object representing the collection of nodes across which the operation is performed. + + + + Performs the specified operation across all nodes. + + A descendant representing the operation to be performed. + + + + Performs the specified method across all nodes. + + A TreeListOperationDelegate object that represents the method to be called for the specified nodes. + + + + Performs the specified operation over a range of nodes that are not hidden within collapsed groups. + + A descendant that specifies the operation to be performed. + A object representing the node from which the iteration begins. + A object representing the node at which the iteration ends. + + + + Returns the visible node located after the specified one. + + A object representing the visible node whose next visible node is returned. + A object representing the visible node located after the specified one. null (Nothing in Visual Basic) if the node specified by the parameter is the last visible node. + + + + Returns the visible node which is located prior to the specified one. + + A object representing the visible node whose previous visible node is returned. + A object representing the visible node which is located prior to the specified one. null (Nothing in Visual Basic) if the node specified by the parameter is the first visible node. + + + + Gets the collection of visible nodes. + + An <,> object specifying the collection of visible nodes. + + + + Serves as the base for classes specifying operations performed on nodes. + + + + + Returns a value indicating whether the iteration must be stopped. + + A object representing the processed node. + true to continue iteration; false to stop the iteration. + + + + Checks whether or not this can be applied to the specific node. + + A to check. + true if this can be applied to the specific node; otherwise, false. + + + + Must be implemented to perform an operation on the visited node. + + A object representing the node against which the operation is to be performed. + + + + Can be overridden to perform final operations and free allocated resources. + + + + + Gets a value indicating whether all or only parent nodes must be processed by the operation. + + true if all nodes must be processed by the operation; false if only nodes that have children are to be processed. + + + + Gets a value specifying whether the operation must be performed on the specified node’s children. + + A object representing the node whose child nodes are to be visited. + true if the operation must be performed on the specified node’s children; otherwise false. + + + + Serves as the base for classes that represent operations performed on visible nodes. + + + + + Checks whether or not this can be applied to the specific node. + + A to check. + true if this can be applied to the specific node; otherwise, false. + + + + Gets a value specifying whether children of the specified node are to be visited. + + A object representing the node whose child nodes are to be visited. + true always. + + + + Represents a node of the Tree List control. + + + + + Initializes a new instance of the class. + + + + + Returns the total number of nodes for this . + + An Int32 value that is the total number of nodes for this . + + + + Copies settings from the target node to this object. + + A TreeListNode whose settings should be copied to this . + + + + Checks the current node and all its nested nodes (including all their children). + + + + + Gets the style of check boxes displayed in the node. + + A value that indicates whether the node displays a check box, radio button, or neither. + + + + Gets or sets whether the node is checked. + + true if the node is checked; otherwise, false. + + + + Gets or sets the node’s check state. + + A enumeration value that specifies the node’s check state. + + + + Gets or sets whether all child nodes owned by this node should display check boxes, radio buttons, or neither. + + A DevExpress.XtraTreeList.NodeCheckBoxStyle enumeration value that specifies what child nodes should display. The Default value means child nodes follow the global TreeListOptionsView.CheckBoxStyle setting. + + + + Returns a copy of this node. + + A object representing this node’s copy. + + + + Collapses the node. + + true to collapse the node with animation; otherwise, false. + + + + Collapses all child nodes. + + + + + Gets or sets a value that can be freely used as your specific programming needs dictate. + + A value of the object type bound to the current node. + + + + Expands the node. + + true to expand the node with animation; otherwise, false. + + + + Expands all the child nodes. + + + + + Gets or sets whether the node is expanded. + + true if the node is expanded; otherwise, false. + + + + Gets the first child node. + + A object which represents the first child node. null (Nothing in Visual Basic) if the current node has no child nodes. + + + + Gets whether the node is currently focused. + + true if the node is focused; otherwise, false. + + + + Returns the text representation of a specific column value. + + An object that identifies a column (a object, field name, column’s absolute index or corresponding DataColumn object). + A text string that represents a specific column value. + + + + Returns the value for a specific column, or null if no column with such columnID was found. + + An object that identifies a column (a object, field name, column’s absolute index or corresponding DataColumn object). + The value of a specific column. + + + + Determines whether the current node has a instance as a parent. + + The instance to check. + true if the current node has a instance as a parent; otherwise, false. + + + + Gets or sets a value indicating whether a node has children. + + true if a node has children; otherwise, false. + + + + Gets the index of the corresponding record within the associated data source. + + An integer value representing the zero-based index of the corresponding data source record. + + + + Gets or sets the index of the node’s select image from the TreeList.SelectImageList collection displayed when this node is not focused. + + An integer value that specifies the zero-based index of the select image displayed when this node is not focused. + + + + Gets whether the current node is selected. + + true if the node is selected; otherwise, false + + + + Gets or sets a value for a specific column. + + An object that identifies a column (a object, field name, column’s absolute index or corresponding DataColumn object). + The value for a specific column. + + + + Gets the last child node. + + A object which represents the last child node. null (Nothing in Visual Basic) if the current node has no child nodes. + + + + Returns the nesting level of a node. + + The nesting level of a node. + + + + Returns the next node in the collection. + + A object which represents the next node in the collection. null (Nothing in Visual Basic) if the current node is the last node in the collection. + + + + Returns the next visible node after the current node. + + A object which represents the next visible node after the current one. null (Nothing in Visual Basic) if the current node is the last visible node. + + + + Gets the collection of the node’s children. + + A object representing the node’s child nodes collection. + + + + Gets the parent node of the current tree node. + + A instance that represents the parent of the current tree node. + + + + Gets the previous node in the collection. + + A object which represents the previous node in the collection. null (Nothing in Visual Basic) if the current node is the first node in the collection. + + + + Returns the visible node located prior to the current node. + + A object which represents the visible node located prior to the current one. null (Nothing in Visual Basic) if the current node is the first node in the Tree List’s TreeList.Nodes collection. + + + + Removes this node. + + + + + Gets a node at the root level which contains the current node as a child. + + The node at the root level which contains the current node as a child. + + + + Returns the total number of rows occupied by all child nodes that belong to this node. The row occupied by this itself is not included in the RowCount number. + + An Int32 value that is the total number of rows. + + + + Gets or sets the index of the node’s select image from the TreeList.SelectImageList collection displayed when this node is focused. + + An integer value that specifies the zero-based index of the select image displayed when the node is focused. + + + + Gets the source of select images for nodes. + + The source of select images. + + + + Sets the value for a specific column. + + An object that identifies a column (a object, field name, column’s absolute index or corresponding DataColumn object). + The value to set for a specific column in the current node. + + + + Sorts the node’s children against a column. + + The sort column. + The sort order. + true, to sort nodes recursively; otherwise, false. + + + + Sorts the nodes’ children using the specified IComparer object. + + The object that compares Tree List nodes. + true, to sort nodes recursively; otherwise, false. + + + + Gets or sets the index of the node’s state image from the TreeList.StateImageList collection. + + An integer value that specifies the node’s state image index. + + + + Gets the source of state images for nodes. + + The source of state images. + + + + Gets or sets the data associated with a Tree List node. + + An object containing information associated with the Tree List node. + + + + Gets the object to which the current node belongs. + + A object to which the current node belongs. + + + + Unchecks the current node and all its nested nodes (including all their children). + + + + + Gets or sets whether the node is visible. The property allows you to perform node filtering. + + true if the node is visible; otherwise, false. + + + + Represents a collection of objects in the component. + + + + + Creates a collection of child nodes for a specific parent node. + + A class instance to which the collection belongs. + The node for which to create a collection of child nodes. + + + + Creates a collection of nodes at the root level of the Tree List. + + A instance to which the node collection belongs. + + + + Appends a new node to the end of the collection and initializes the node with the specified data. + + An array of values or a object, used to initialize the created node’s cells. + The new object. + + + + Adds a new child containing the specified values. + + An array of values or a object, used to initialize the created node’s cells. + The created object. + + + + Gets the Automatic Filtering Row element. + + A TreeListAutoFilterNode object that is the Automatic Filtering Row. + + + + Removes all elements from the current node collection. + + + + + Copies the entire nodes collection to a one dimensional array starting at the specified index of the target array. + + A one-dimensional array that is the destination of nodes copied from the collection. + An integer value specifying the zero-based index in the target array at which copying begins. + + + + Gets the number of nodes in the current node collection, without taking into account children of these nodes. + + The number of nodes in the current node collection. + + + + Gets the first element in the collection. + + A object representing the first node in the collection. null (Nothing in Visual Basic) if the collection is empty. + + + + Gets the enumerator used to iterate through the node collection. + + An enumerator through which the node collection can be iterated. + + + + Returns the index of a specified node within the node collection. + + The node to locate in the collection. + The index of a specific node within the node collection. + + + + Gets a value indicating whether access to the nodes collection is synchronized (thread-safe). + + true if access to the nodes collection is synchronized (thread-safe); otherwise false. + + + + Obtains the object by a specific index in the current node collection. + + The zero-based index of the node to locate. The index is a value between 0 and TreeListNodes.Count - 1. + A child at the specified index within the node collection. + + + + Gets the last node in the node collection. + + The last node in the node collection. + + + + Gets the parent of the node collection. + + A instance that represents the parent of the node collection. + + + + Removes a specific node from the node collection. + + The node to remove from the node collection. + + + + Removes a node referenced by the specified index from the node collection. + + The index of the node to remove from the node collection. + + + + Gets an object that can be used to synchronize access to the nodes collection. + + An object that can be used to synchronize access to the nodes collection. + + + + Gets the object to which the node collection belongs. + + A object to which the node collection belongs. + + + + Contains options that specify how a control’s layout is saved to/restored from storage (a stream, xml file or the system registry). + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the columns that exist in the current control but do not exist in a layout when it’s restored should be retained. + + true to retain the columns that exist in the current control’s layout but don’t exist in the layout being restored; false to destroy such columns. + + + + Copies the settings from the object passed as the parameter. + + An object whose settings are copied to the current object. + + + + Gets or sets whether the columns that exist in a layout when it’s restored, but that don’t exist in the current control, should be discarded or added to the control. + + true to discard the columns that exist in the layout being restored, but don’t exist in the current control; false to add these columns to the control. + + + + Gets or sets whether to include all column settings in the layout when it is saved or restored. + + True, Default to include all column settings in the layout; otherwise, False. + + + + Gets or sets whether to reset all options to their defaults before restoring the saved layout. + + true, to reset all options to their defaults before restoring the saved layout; Otherwise, false. + + + + Gets or sets whether the control’s appearance settings are also stored when the layout is saved to storage, and restored when the layout is restored from storage. + + true if the control’s appearance settings are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false. + + + + Gets or sets whether to include column/band width and visibility information in the layout when it is saved or restored. + + True, Default to include column/band width and visibility information in the layout; otherwise, False. + + + + Gets or sets whether to include sorting, filtering, and summary information in the layout when it is saved or restored. + + True, Default to include sorting, filtering, and summary information in the layout; otherwise, False. + + + + Gets or sets whether to include information about conditional formatting (if applied) in the layout when it is saved or restored. + + True, Default to include information about conditional formatting in the layout; otherwise, False. + + + + Gets or sets whether to include and TreeList.OptionsView settings in the layout when it is saved or restored. + + True, Default to include visual settings information in the layout; otherwise, False. + + + + Provides data for the TreeList.PopupMenuShowing event. + + + + + Initializes a new instance of the class with the specified settings. + + A TreeListMenu object that specifies the menu to be displayed. This value is assigned to the PopupMenuShowingEventArgs.Menu property. + A Point value that specifies the point at which the menu is to be displayed. PopupMenuShowingEventArgs.Point + A Boolean value that specifies if display of the menu is allowed. This value is assigned to the PopupMenuShowingEventArgs.Allow property. + + + + Gets or sets if display of the menu is allowed. + + true if display of the menu is allowed; otherwise, false. + + + + Provides access to information about the clicked visual element. + + An object that contains information about a visual element. + + + + Gets or sets the control’s popup menu that will be shown. + + A TreeListMenu object that is the menu that will be shown. + + + + Gets the type of the context menu that is about to be shown. + + A value that specifies the menu type. + + + + Gets the position where the menu is to be invoked. + + A Point value that specifies the position where the menu is to be invoked. + + + + Represents a method that will handle the TreeList.PopupMenuShowing event. + + The event source. This parameter identifies the which raised the event. + A object which contains event data. + + + + Contains types that provide the printing functionality. + + + + + Provides extension methods for the class. + + + + + Invokes the specified method that accepts the collection of band headers as a parameter. + + The object extended with this method. + The action that accepts the processed cell values, column or band headers, group row header, or summaries in the group row. + + + + Invokes the specified method that accepts the collection of column headers as a parameter. + + The object extended with this method. + The action that accepts the processed cell values, column or band headers, group row header, or summaries in the group row. + + + + Invokes the specified method that accepts a group row value as a parameter. + + The object extended with this method. + The action that accepts the processed cell values, column or band headers, group row header, or summaries in the group row. + + + + Invokes the specified method that accepts the collection of summary values in a group row as a parameter. + + The object extended with this method. + The action that accepts the processed cell values, column or band headers, group row header, or summaries in the group row. + + + + Invokes the specified method that accepts the collection of cell values as a parameter. + + The object extended with this method. + The action that accepts the processed cell values, column or band headers, group row header, or summaries in the group row. + + + + Provides data for the clipboard in a variety of formats (plain text, plain unicode text, rich text, CSV, BIFF8, HTML). + + + + + Initializes a new instance of the class with specified settings. For internal use. + + The clipboard manager. For internal use. + + + + Returns data for the clipboard in the CSV format. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + A string value that specifies data in the CSV format that should be passed to the clipboard. + + + + Returns data for the clipboard in the specified format(s). + + A combination of values that specify data formats. + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + An object that specifies data that should be passed to the clipboard. + + + + Returns data for the clipboard in all supported formats. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + An object that specifies data that should be passed to the clipboard. + + + + Returns data for the clipboard in Microsoft Excel’s binary file format (BIFF). + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + An object that provides a stream for data that should be passed to the clipboard. + + + + Returns data for the clipboard in the HTML format. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + A string value that specifies data in the HTML format that should be passed to the clipboard. + + + + Returns data for the clipboard in the rich text format. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + A string value that specifies data in the rich text format that should be passed to the clipboard. + + + + Returns data for the clipboard in the plain text format. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + A string value that specifies data in the plain text format that should be passed to the clipboard. + + + + Returns data for the clipboard in the plain unicode text format. + + An object that contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + A string value that specifies data in the plain unicode text format that should be passed to the clipboard. + + + + Contains a set of options that specify whether to copy column headers, collapsed groups, and other elements to the clipboard. + + + + + Initializes a new instance of the class with specified settings. + + true, to copy column headers to the clipboard; otherwise, false. + true, to copy collapsed nodes to the clipboard; otherwise, false. + true, to copy the tree hierarchy (indents) to the clipboard; otherwise, false. + + + + Gets or sets whether to copy the tree hierarchy (indents) to the clipboard. + + true, to copy the tree hierarchy (indents) to the clipboard; otherwise, false. + + + + Supplies data for the , , and events. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets an object that identifies the clicked UI element. + + A object that identifies the clicked UI element. + + + + Lists values specifying the availability of the control’s elements that enable data scrolling. + + + + + The scrolling element is always visible. + + + + + The scrolling element is only visible when data scrolling can be performed. + + + + + The scrollbar is invisible regardless of whether data scrolling can be performed. + + + + + Contains data for the event. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets an action that describes how the collection of selected nodes is about to change. + + Specifies how the collection of selected nodes is about to change. + + + + Gets the processed node. + + The processed node. + + + + Contains settings that define the visibility of editor buttons within a cell. + + + + + Specifies the default behavior for all columns - buttons are displayed only for the focused cell. If a column’s TreeListColumn.ShowButtonMode property is specified, the behavior specified by the Tree List is overridden. + + + + + Buttons are always displayed. + + + + + Buttons are displayed only for the focused cell. + + + + + Buttons are displayed for all cell editors in the focused row. + + + + + Buttons are displayed only when a cell editor is active. + + + + + Contains values that specify when the Filter Panel is visible. + + + + + The Filter Panel is shown when a filter is applied to the control. Otherwise, the Filter Panel is hidden. + + + + + The Filter Panel is hidden. + + + + + The Filter Panel is always shown at the bottom of the control. + + + + + Contains classes that support the style conditions feature in the Tree List control. + + + + + A single style condition. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the type of the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + A object that represents the column whose values are involved in conditional formatting. This value is assigned to the StyleFormatCondition.Column property. + Any object to be associated with the created style condition. This value is assigned to the StyleFormatConditionBase.Tag property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value1 property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value2 property. + true to apply the specified style to entire nodes that contain cells matching the defined criteria; false to apply the style to individual cells. This value is assigned to the StyleFormatCondition.ApplyToRow property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the type of the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + A object that represents the column whose values are involved in conditional formatting. This value is assigned to the StyleFormatCondition.Column property. + Any object to be associated with the created style condition. This value is assigned to the StyleFormatConditionBase.Tag property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value1 property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value2 property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the type of the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + A object that represents the column whose values are involved in conditional formatting. This value is assigned to the StyleFormatCondition.Column property. + Any object to be associated with the created style condition. This value is assigned to the StyleFormatConditionBase.Tag property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value1 property. + + + + Initializes a new instance of the class with the specified settings. + + A enumeration value that specifies the type of the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + Any object to be associated with the created style condition. This value is assigned to the StyleFormatConditionBase.Tag property. + A descendant which provides the appearance settings used to paint the cells that meet the specified condition. This value is assigned to the StyleFormatConditionBase.Appearance property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value1 property. + An object that is compared to cell values as specified by the condition parameter. This value is assigned to the StyleFormatConditionBase.Value2 property. + A object that represents the column whose values are involved in conditional formatting. This value is assigned to the StyleFormatCondition.Column property. + true to apply the specified style to entire nodes that contain cells matching the defined criteria; false to apply the style to individual cells. This value is assigned to the StyleFormatCondition.ApplyToRow property. + + + + Initializes a new instance of the class with the specified comparison operation type. + + A enumeration value that specifies the type of the comparison operation. This value is assigned to the StyleFormatConditionBase.Condition property. + + + + Gets or sets whether the appearance settings are to be applied to entire nodes or individual cells. + + true to apply the appearance settings to entire nodes; otherwise, false. + + + + Copies the properties of the specified object to the current object. + + The object whose properties should be copied. + + + + Gets or sets the column whose values take part in conditional formatting. + + A object representing the column whose values are used in conditional formatting. null (Nothing in Visual Basic) if all columns’ values are involved. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The name of the column to which the current condition is applied. + + + + A style condition collection. + + + + + Initializes a new instance of the class. + + A control that will own the new collection. The value is assigned to the StyleFormatConditionCollection.TreeListControl property. + + + + Adds the specified style condition object to the end of the collection. + + A object to be added to the collection. + + + + Adds an array of style condition objects. + + An array of objects to be added to the collection. + + + + Compares the two specified values. + + The first value to compare. + The second value to compare. + 0 if the values are equal; -1 if the first value is less than the second value; 1 if the first value is greater than the second value. + + + + Gets whether the control that owns the current collection is being initialized. + + true if the control that owns the current collection is being initialized; otherwise, false. + + + + Provides indexed access to style conditions in the current collection. + + An integer that represents the zero-based index of the object to be returned. + A object with the specified index. + + + + Provides access to style conditions, using the data that is stored in the Tag property as an indexer. + + An object to search against the StyleFormatConditionBase.Tag properties of style conditions stored in this collection. + A object which contains the specified tag object in the StyleFormatConditionBase.Tag property. + + + + Gets a control that owns the current collection. + + A object which is the owner of the current collection. + + + + Specifies a single style format rule for a control. + + + + + Initializes a new instance of a class. + + + + + Gets or sets whether the format is applied to the entire row. + + true if the format is applied to the entire row; otherwise, false. + + + + Copies settings from the specified object to the current object. + + An object whose settings are to be copied to the current object. + + + + Gets or sets a column that provides values to test against the current format rule. By default, the format is applied to this column. + + The column that provides values to test against the current formatting rule. + + + + Gets or sets a column, to which the format should be applied instead of the column specified by the TreeListFormatRule.Column property. + + The target column to which the format is applied. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The name of the column to which a format is applied. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + The name of the column that provides values to test against the current formatting rule. + + + + Returns whether the current format rule evaluates to “true” for the specified cell. + + The column to which the cell belongs. + The node to which the cell belongs. + true if the current rule is true for the specified cell; otherwise, false. + + + + Gets whether the current object is properly customized. + + true if the object is properly customized; otherwise, false. + + + + Returns the appearance settings to apply to a specific cell. + + The column that contains the cell. + The node that contains the cell. + An object with appearance settings to apply to a specific cell. + + + + Gets the object that owns the current formatting rule. + + A object that owns the current formatting rule. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + An object that will own the collection of formatting rules. + + + + Gets the object that owns the current collection of formatting rules. + + A object that owns the collection of formatting rules. + + + + Specifies summary type to calculate against a group of column cells. + + + + + Calculates the average field value within a group of column cells. + + + + + Calculates the number of nodes within a group of column cells. + + + + + Allows a user to define a custom summary value by handling the TreeList.GetCustomSummaryValue event. + + + + + Retrieves the maximum value within a group of column cells. + + + + + Retrieves the minimum value within a group of column cells. + + + + + Summary is not calculated. + + + + + Calculates the sum of field values within a group of column cells. + + + + + Displays data as a multi-column tree view. Can be used in either bound or unbound mode. See Tree List for more information. + + + + + Initializes a new class instance. + + + + + Brings up the About dialog. + + + + + Notifies accessibility client applications of the specified event for the specified child control. + + An event being fired. + An object that identifies a control to notify of the accessible event. + + + + Notifies accessibility client applications of the specified event for the specified child control. + + An event being fired. + The identifier of the AccessibleObject. + A child which fires the event. + + + + Gets the currently active cell editor. + + A descendant representing the currently active editor. null (Nothing in Visual Basic) if no cell is being edited at the moment. + + + + Retrieves the filtering criteria currently applied to this . + + A DevExpress.XtraTreeList.TreeFilter object that is the filtering criteria applied to this . + + + + Gets or sets the current filter criteria. + + A object which is the total filter criteria. + + + + Gets or sets whether the filtering functionality is enabled. + + true to enable filtering; otherwise false. + + + + Gets the total filter expression. + + A DevExpress.XtraTreeList.TreeListFilterInfo object specifying the total filter expression. + + + + Gets or sets the total filter expression for the TreeList. + + A string that specifies the total filter expression applied to the TreeList. + + + + Adds a CriteriaOperator-based filter to the current . + + A object that contains a filtering condition. + + + + Adds a predefined filter with a string filtering condition to the current . + + A String value that is the filtering condition. + + + + Occurs after a node’s check state has been changed by an end-user. + + + + + Fires immediately after a node has been collapsed. + + + + + Fires immediately after a drag-and-drop operation on a node has been successfully completed. + + + + + Fires after a node is dropped. + + + + + Fires immediately after a node has been expanded. + + + + + Fires in response to focus being moved between nodes. + + + + + Returns the total number of nodes within the TreeList. + + An integer value indicating the total number of nodes. + + + + Provides access to the properties that control the appearance of the Tree List’s elements. + + A object which provides the appearance settings for the Tree List’s elements. + + + + Provides access to the properties that specify the appearances of the Tree List’s elements when the Tree List is printed and exported. + + A object which provides the appearance settings used to paint the Tree List’s elements when the Tree List is printed and exported. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + A parent node for the added one. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Adds a that contains the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + A parent node. + The node’s check state. + A NodeCheckBoxStyle enumeration value that specifies whether all child nodes owned by the created node should display check boxes, radio buttons, or neither. This value is assigned to the TreeListNode.ChildrenCheckBoxStyle property. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + A parent node for the added one. + The node’s check state. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Appends a new node with the specified settings. + + An array of values or a object, used to initialize the created node’s cells. + A object that represents the parent node. + The node’s check state. + A object that represents the added node. + + + + Adds a new containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + A parent node of the added one. + A object representing the added node. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the identifier of the parent node. + A zero-based index of the image displayed within the node. + A zero-based index of the image displayed within the node when it is focused or selected. + An integer value that specifies the index of the node’s state image. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Adds a that contains the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the identifier of the parent node. + A zero-based index of the image displayed within the node. + A zero-based index of the image displayed within the node when it is focused or selected. + An integer value that specifies the index of the node’s state image. + The node’s check state. + A NodeCheckBoxStyle enumeration value that specifies whether all child nodes owned by the created node should display check boxes, radio buttons, or neither. This value is assigned to the TreeListNode.ChildrenCheckBoxStyle property. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the identifier of the parent node. + A zero-based index of the image displayed within the node. + A zero-based index of the image displayed within the node when it is focused or selected. + An integer value that specifies the index of the node’s state image. + The node’s check state. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Appends a new node with the specified settings. + + An array of values or a object, used to initialize the created node’s cells. + An integer value that identifies the parent node. + A zero-based index of the image displayed within the node. + A zero-based index of the image displayed within the node when it is focused or selected. + An integer value that specifies the index of the node’s state image. + The node’s check state. + A object that represents the added node. + + + + Appends a new node with the specified settings. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the parent node’s identifier. + A zero-based index of the image displayed within the node. + A zero-based index of the image displayed within the node when it is focused or selected. + An integer value that specifies the index of the node’s state image. + A object representing the added node. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the identifier of the parent node. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Adds a containing the specified values to the XtraTreeList. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the identifier of the parent node. + The node’s check state. + An object that contains information associated with the Tree List node. This value is assigned to the TreeListNode.Tag property. + A object or descendant representing the added node. + + + + Appends a new node with the specified settings. + + An array of values or a object, used to initialize the created node’s cells. + An integer value that identifies the parent node. + The node’s check state. + A object that represents the added node. + + + + Appends a new node containing the specified values to the specified node’s child collection. + + An array of values or a object, used to initialize the created node’s cells. + An integer value specifying the parent node’s identifier. + A object or descendant representing the added node. + + + + Fills in the Find Panel with the specified query and applies it. + + A String value that specifies the query. + true if the specified query is successfully applied; otherwise, false. + + + + Gets or sets a column that automatically stretches to occupy all available empty space when the column auto-width functionality is disabled. + + A object that occupies free space. + + + + Gets or sets a data source field, whose associated Tree List column should automatically resize to occupy all available space. + + A value that specifies a data source field, whose associated Tree List column should automatically resize to occupy all available space. + + + + Contains a value which specifies the Automatic Filtering Row‘s ID. + + + + + Gets the background color for the control’s empty space. + + A Color structure that specifies the background color for the control’s empty space. + + + + Gets or sets the logical row height of band headers. + + A value that specifies the band panel row height, in pixels. + + + + Fires after a band changes its position or visibility. + + + + + Provides access to the root band collection. + + An object that specifies the root band collection. + + + + Occurs when the band’s width is changed. + + + + + Occurs before a node’s check state is changed. + + + + + Fires before a node is collapsed. + + + + + Fires when an attempt to drag a node is performed. + + + + + Fires when a node is about to be dropped, and allows you to cancel the operation. + + + + + Fires before a node is expanded. Allows you to implement dynamic node loading in unbound mode. + + + + + Fires before a node is focused. + + + + + Occurs before a layout is restored from storage (a stream, xml file or the system registry). + + + + + Prevents deletion updates until the TreeList.EndDelete method is called. + + + + + Prevents selection updates until the TreeList.EndSelection method is called. + + + + + Prevents the tree structure from being changed when changing specific options affecting the order of nodes, until the TreeList.EndSort method is called. + + + + + In unbound mode, prevents updates of + the tree structure due to adding, deleting and modifying nodes, until the TreeList.EndUnboundLoad method is called. + + + + + Locks the , preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. + + + + + Modifies the width of each visible column so that the contents of its cells are not truncated, if possible. + + + + + Modifies the width of each visible column so that the contents of its cells are not truncated, if possible. Allows you to resize columns to fit the treelist width. + + true if the total width of columns must be equal to the control’s width after resizing; otherwise false. + + + + Gets or sets a value specifying which nodes take part in calculations when applying best fit to columns. + This property is obsolete. Use the TreeListOptionsView.BestFitNodes property instead. + + true to take into account only nodes not hidden within collapsed groups; otherwise false. + + + + Gets or sets the border style for the Tree List. + + A enumeration value specifying the border style of a Tree List. + + + + Returns information about the Tree List’s elements which are located at the specified point. + + A structure which specifies test point coordinates relative to the Tree List’s top-left corner. + A object which contains information about the Tree List’s elements located at the test point. + + + + Enables you to specify a custom image to be displayed in front of nodes during node drag-and-drop. + + + + + Allows you to assign custom node height. + + + + + Cancels changes made to focused node cells. + + + + + Unlocks control redrawing after it has been locked by the TreeList.BeginSort method, without causing an immediate visual update. + + + + + Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update. + + + + + Gets whether or not the Tree List data can be filtered by the specific column’s data. + + A to be checked. + true if filtering by this column is enabled; otherwise, false. + + + + For internal use. + + + + + For internal use. + + + + + Gets a value indicating whether the current cell’s editor can be invoked. + + true if the current cell’s editor can be invoked; otherwise false. + + + + Gets whether group footers are allowed to be displayed. + + true if group footers are allowed to be displayed; otherwise, false. + + + + Gets whether or not the specific can be sorted. + + A to be checked. + true if the column can be sorted; otherwise, false. + + + + Gets or sets the caption displayed at the top of the control. + + A value that specifies the caption that is displayed at the top of the control. + + + + Gets or sets the height, in pixels, of the panel at the top of the control in which the caption is displayed. + + An integer value that specifies the height, in pixels, of the panel at the top of the control in which the caption is displayed. + + + + Fires immediately after a user closes a cell editor with a modified value. + + + + + Fires when an end-user starts to edit a cell value. + + + + + Checks all TreeList nodes. + + + + + Gets or sets the name of the field whose values define the node check states. + + The name of the field to bind to the node check states. + + + + Gets or sets the name of the collection property that returns child items in a bound business object. See Virtual Mode - Binding to a Hierarchical Business Object (Data Source Level) for more information. + + The name of the collection property that returns child items in a bound business object. + + + + Removes the error descriptions for a focused node. + + + + + Removes the filter condition applied to the specified column. + + A object specifying the column which filter condition is to be discarded. + + + + Removes the filter criteria applied to the TreeList. + + + + + Clears a print/export document. + + + + + Discards the query in the Find Panel. + + + + + Removes focus from the focused column. + + + + + Removes all nodes from the XtraTreeList. + + + + + Unselects all nodes, and removes them from the TreeList.Selection collection. + + + + + Clears all the sorting that has been applied to an Tree List control. + + + + + Gets an object that provides data for the clipboard in various formats (plain text, plain unicode text, rich text, CSV, BIFF8, HTML). + + An object that provides data for the clipboard in various formats (plain text, plain unicode text, rich text, CSV, BIFF8, HTML). + + + + Fires before a data row, a group row, column headers, or band headers are copied to the clipboard. Allows you to apply a format, change copied data, or skip a data row or header. + + + + + Fires before a node is pasted to the control. Allows you to apply a format, update the pasted data, or skip a data row. + + + + + Closes the Edit Form. + + true if data is successfully saved and the Edit Form is closed; otherwise, false. + + + + Hides the active editor, saving changes that were made. + + + + + Collapses all the nodes in the Tree List. + + + + + Collapses all nodes at the specified and subsequent levels. + + An value that specifies the level starting from which nodes should be collapsed. 0 to collapse nodes starting from the root. + + + + Fires when the column button is clicked. + + + + + Fires immediately after the column collection or an individual column has been modified. + + + + + Occurs when a column’s filter condition is changed. + + + + + Gets or sets the height of the column header panel, in pixels. + + An integer value specifying the column panel height in pixels. + + + + Fires when a column is moved, hidden, or shown. + + + + + Provides access to a Tree List’s column collection. + + A object representing a collection of all the columns within a Tree List. + + + + Gets or sets the source of images that can be displayed within column headers and bands. + + An object that is the source of images that can be displayed within column headers and bands. + + + + Fires after a column’s TreeListColumn.UnboundExpression property has been changed. + + + + + Fires after a column’s width has been changed. + + + + + Enables you to implement custom sorting for columns whose TreeListColumn.SortMode property is set to Custom. For versions 17.1 and higher, the CompareNodeValues event is deprecated and replaced with the TreeList.CustomColumnSort event. + + + + + Converts objects from the TreeList.FormatConditions collection to objects and adds them to the TreeList.FormatRules collection. + + + + + Copies the specified node to the specified position in the collection of child nodes of another node. Use this method in unbound mode. + + The node to copy. + The target node to which the source node is copied. + true to copy child nodes of the source node; otherwise false. + A zero-based integer that specifies the position among the child nodes of the target node to insert the source node. + A copy of the original (source) node. + + + + Copies the specified node to the specified node’s child collection. This method does not update the data source and is intended for use in unbound mode. + + A object representing the node to be copied. + A object representing the node to whose child collection the node is copied. + true if child nodes of the node being copied must be cloned; otherwise false. + A object representing the copy of the specified node. + + + + Copies the specified nodes to the specified position in the collection of child nodes of another node. Use this method in unbound mode. + + The nodes to copy. + The target node to which the source node is copied. + true to copy child nodes of source nodes; otherwise false. + A zero-based integer that specifies the position among the child nodes of the target node to insert the source nodes. + The copies of the original (source) nodes. + + + + Copies selected nodes to the Clipboard. + + + + + Invokes the Customization Form. + + + + + Provides the ability to create custom nodes. + + + + + Initializes a GraphicsCache object for this . GraphicsCache objects provide an API that you should use instead of the standard Graphics class API to custom paint a TreeList when it has the DirectX Hardware Acceleration enabled. + + A GraphicsCache object associated with this . + + + + Gets or sets the cursor that is displayed when the mouse pointer is over the control. + + The cursor to display when the mouse pointer is over the control + + + + Fires for both bound and unbound Tree List columns and allows you to provide a custom display text for any cell. + + + + + Allows you to apply custom sorting for those Tree List columns whose TreeListColumn.SortMode is set to Custom. + + + + + Provides the capability to custom paint band headers. + + + + + Provides the ability to custom paint column headers and the column button. + + + + + Enables you to custom paint a Tree List’s empty area. + + + + + Enables you to custom paint the Filter Panel. + + + + + Gives you the ability to perform custom painting of the summary footer. + + + + + Gives you the ability to perform custom painting of column footer cells. + + + + + Gives you the ability to perform custom painting of expand buttons. + + + + + Provides the ability to perform custom painting of node cells. + + + + + Enables you to manually paint node check boxes. + + + + + Provides access to a GDI+/DirectX drawing surface and allows you to draw node icons manually. + + + + + Enables tree indents to be painted manually. + + + + + Provides the ability to perform custom painting of indicator cells. + + + + + Allows you to custom paint preview sections. + + + + + Enables you to paint rows. + + + + + Provides the ability to perform custom painting of row footers. + + + + + Provides the ability to perform custom painting of row footer cells. + + + + + Allows you to draw custom scrollbars, or highlight specific positions on the scrollbars. + + + + + Allows you to customize the text displayed within the Filter Panel. + + + + + Gets the object representing the Customization Form. + + + + + Gets or sets the boundaries of the Customization Form. + + A structure representing the Customization Form’s boundaries. + + + + Allows you to filter search results when a user searches in the Advanced Customization Form. + + + + + This property is obsolete. Use the TreeList.CustomizationFormBounds property instead. + + + + + Allows you to initialize a new node when a user drops the node from another TreeList control onto the current TreeList control. + + + + + Allows you to customize templated nodes. + + + + + Enables editors to be assigned to cells on an individual basis. To avoid performance issues and increased memory consumption, assign repository items that already exist in the TreeList.RepositoryItems collection. Do not create new repository items in this handler. + + + + + Allows you to assign a custom editor to a column for in-place editing and override the default column editor, which is by default used both in display and edit modes. To avoid performance issues and increased memory consumption, assign repository items that already exist in the TreeList.RepositoryItems collection. Do not create new repository items in this handler. + + + + + Allows you to specify the node visibility, regardless of the applied filter. + + + + + Allows you to specify custom annotations. + + + + + Allows you to provide data to unbound columns, and save their modified records to an external source. + + + + + Gets or sets a specific list in a data source whose data is displayed by the TreeList control. + + A string value specifying a list in a data source. + + + + Gets or sets the data source for the current control. + + The data source object. + + + + Occurs whenever the changes its data source. + + + + + Fires when a different paint helper is assigned to the TreeList control. + + + + + The default value for the TreeList.TreeLevelWidth property. + + + + + Removes a specific from the XtraTreeList. + + The removed . + + + + Deletes the specified nodes. + + Nodes do delete. + + + + Deletes the selected nodes in multiple selection mode or focused nodes in single selection mode. + + + + + Gets or sets whether the control’s accessibility feature (providing information on the control’s data to accessibility tools, such as Microsoft Narrator) is disabled. + + true if the control’s accessibility feature is disabled; otherwise, false. + + + + Allows you to implement drag-and-drop operations between controls on tree list nodes. Begins a drag-and-drop operation, and forces the tree list and target control to raise the events relative to the operation. + + The node to drag. + A enumeration value that specifies the allowed drag effects. + + + + Allows you to implement drag-and-drop operations between controls on tree list nodes. Begins a drag-and-drop operation, and forces the tree list and target control to raise the events relative to the operation. + + The collection of nodes to drag. + A enumeration value that specifies the allowed drag effects. + + + + Continues the incremental search that is in progress in the specified direction. + + true to continue the incremental search forward; false to continue the incremental search backward. + true if another node with the specified search string has been found and focused; otherwise, false. + + + + Fires immediately after a drag-and-drop operation over a node has been canceled. + + + + + Gets or sets the amount of time (in milliseconds) before the node is expanded when another node is dragged over it. + + An integer value specifying the delay (in milliseconds) from the time a dragged node begins hovering over a collapsed node to the time that the node is expanded. + + + + Gets or sets how end-users can drop nodes. + + A value that specifies the node drop mode. + + + + Fires immediately after the drag and drop operation has been completed. + + + + + Enables you to control whether the dragged column header can be dropped at the current position. + + + + + Fires when an end-user attempts to drag a column header. + + + + + Fires after the Edit Form is closed. + + + + + Fires when the Edit Form is about to be displayed. Allows you to customize the Edit Form. + + + + + Fires when the Edit Form is about to be displayed. Allows you to cancel the action. + + + + + Gets or sets the cell value being edited. + + An object representing the currently edited cell value. null (Nothing in Visual Basic) if editing is not being performed at the moment. + + + + Specifies the default HTML-CSS template for an empty TreeList control. + + The default HTML-CSS template for an empty TreeList control. + + + + Gets or sets whether a node hierarchy is created dynamically (on node expansion) or all at once on initial loading. This property is in effect in virtual binding mode. + + true if a node hierarchy is created dynamically (on node expansion); false if a node hierarchy is created all at once on initial loading. + + + + Gets or sets whether the Tree List uses an enhanced scroll mechanism, which only repaints the part of its area that becomes visible after a scroll operation. + + true, if, during scrolling, Tree List redraws the part of its area that becomes visible, and does not invalidate the rest of the area; false, to repaint the scrollable area in its entirety. + + + + Gets or sets whether the updated column width calculation mechanism is enabled. + + true if the updated mechanism is enabled; otherwise, false. + + + + Posts the focused node’s values to the data source. Set the EndCurrentEdit(System.Boolean) parameter to true to re-sort and re-filter the tree after saving changes. + + + + + Posts the focused node’s values to the data source and optionally re-sorts and re-filters the tree. + + true to re-sort and re-filter the tree; otherwise, false. + + + + Enables deletion updates after calling the TreeList.BeginDelete method and forces an immediate update. + + + + + Enables selection updates after calling the TreeList.BeginSelection method and forces an immediate update. + + + + + Forces the control to update itself after the TreeList.BeginSort method has been called. + + + + + Fires after a sorting operation has finished. + + + + + Forces the control to update itself after the TreeList.BeginUnboundLoad method has been called. + + + + + Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update. + + + + + Expands all Tree List nodes. + + + + + Expands nodes up to the specified level. + + An value that specifies the level up to which nodes should be expanded. + + + + Exports the control’s data to the specified stream in CSV format using the specified options. + + A object to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports data to the specified stream in CSV format. + + A object to which the created document is exported. + + + + Exports the control’s data to the specified file in CSV format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to the specified CSV file. + + A which specifies the name (including the full path) of the file to which the control is exported. + + + + Exports the control’s data in the Office Open XML format (DOCX file) and sends it to the specified stream. + + A object that specifies the stream to which the document should be sent. + A object that specifies how to export data. + + + + Exports the control’s data in the Office Open XML file format (DOCX file) and sends it to the specified stream. + + A System.IO.Stream object to which the created document should be exported. + + + + Exports the control’s data in the Office Open XML format and saves it to the specified DOCX file. + + A value that specifies the full path (including the file name and extension) where the DOCX file should be created. + A object that specifies how to export data. + + + + Exports the control’s data in the Office Open XML file format and saves it to the specified DOCX file. + + A System.String value which specifies the full path (including the file name and extension) where the DOCX file should be created. + + + + Exports the control’s data to the specified stream in HTML format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data as HTML and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the control’s data to the specified file in HTML format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to the specified file as HTML. + + A value which contains the full path (including the file name and extension) specifying where the HTML file will be created. + + + + Exports the control’s data to the specified stream in MHT format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the control’s data to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A object, to which the created document will be exported. + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the control’s data to the specified file in MHT format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the control’s data to a file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required. + + A that specifies the full path to the file, to which the created document will be exported . + A representing the encoding name set in the output document (e.g. “UTF-8”). + A containing the name shown as the title of the created document. + true if the MHT code is compressed (secondary characters e.g. spaces are removed); otherwise, false. + + + + Exports the control’s data to a file in MHT format using the specified character encoding. + + A that specifies the full path to the file, to which the created document will be exported + A representing the encoding name set in the output document (e.g. “UTF-8”). + + + + Exports the control’s data to the specified stream in PDF format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to a PDF document and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the control’s data to the specified file in PDF format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to the specified PDF file. + + A value which specifies the full path (including the file name and extension) to where the PDF file will be created. + + + + Exports the Tree List’s data as Rich Text and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the Tree List’s data to the specified RTF file. + + A value which specifies the full path (including the file name and extension) to where the RTF file will be created. + + + + Exports the control’s data to the specified stream in Text format using the specified options. + + A object, to which the created document is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to a text document and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the control’s data to the specified file in Text format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to a text file at the specified path. + + A value which specifies the full path (including the file name and extension) to where the text file will be created. + + + + Exports the control’s data to the specified stream in XLS format using the specified options. + + A object, to which the created document is exported. + A object which specifies the XLS export options to be applied when the control is exported. + + + + Exports the Tree List’s data as XLS and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the control’s data to the specified file in XLS format using the specified options. + + A which specifies the name (including the full path) of the file to which the control is exported. + A object which specifies the export options to be applied when the control is exported. + + + + Exports the Tree List’s data to the specified file as XLS. + + A value which specifies the full path (including the file name and extension) to where the XLS file will be created. + + + + Exports data to the specified stream in XLSX (MS Excel 2007) format using the specified options. + + A object, to which the created document is exported. + An object which specifies the XLS export options to be applied when the control is exported. + + + + Exports data to the specified stream in XLSX (MS Excel 2007) format. + + A object, to which the created document is exported. + + + + Exports data to a file in XLSX (MS Excel 2007) format using the specified options. + + A that specifies the full path to the file, to which the created document is exported. + An object which specifies the XLS export options to be applied when the control is exported. + + + + Exports data to the specified file in XLSX (MS Excel 2007) format. + + A that specifies the full path to the file, to which the created document is exported. + + + + Exports the Tree List’s data as XML and sends it to the specified stream. + + A object which the created document is exported to. + + + + Exports the Tree List’s data to the specified file as XML. + + The that contains the full path (including the file name and extension) specifying where the XML file will be created. + + + + Allows you to customize the Filter Editor before it is displayed on screen. + + + + + Allows you to customize the Expression Editor used to edit custom expressions that are displayed in the control’s Filter Editor. + + + + + This event is obsolete. Use the TreeList.CustomRowFilter event instead. + + + + + Forces the Tree List control to re-filter its data. + + + + + Forces data filtering for the specified node collection. + + A collection of nodes to be filtered. + + + + Gets the text displayed within the Filter Panel. + + The text displayed within the filter panel. + + + + Allows you to customize templates used by Excel-style Filter Dropdowns and external editors generated using Filtering UI Context. + + + + + Allows you to add, remove, and modify data values and customize predefined filters in the Excel style pop-up filter menus. Filter items added manually on this event must be unique and sorted. + + + + + Allows you to parse the filter criteria applied to data and select the corresponding values in the filter menu. + + + + + Allows you to replace templates used by Excel-style Filter Dropdowns and external editors generated using Filtering UI Context. + + + + + Fires when a filter criteria is about to be applied to data and allows you to customize the filter criteria. + + + + + Gets the query in the Find Panel. + + A String value that specifies the query in the Find Panel. + + + + Returns the first node that matches the specified criteria. + + The method that defines a set of criteria and determines whether a meets those criteria. + The first node that matches the specified criteria. null (Nothing in Visual Basic) if no matching node is found. + + + + Returns a node by its field value. + + A value which identifies the column. + An object which represents the field value of the requested node. + A object that represents the node which contains the specified value within the specified column. null (Nothing in Visual Basic) if the node isn’t found. + + + + Returns the node specified by its identifier. + + An integer value specifying the identifier of the requested node. + A object representing the node with the specified identifier. null (Nothing in Visual Basic) if there is no node with the specified identifier. + + + + Returns the node by its key field value. + + An object representing the key field value of the requested node. + The node that has the specified key field value. null (Nothing in Visual Basic) if no node is found that matches the criteria. + + + + Returns all nodes that match the specific criteria. + + A Predicate that specifies the search criteria. + An array of the objects that match the specific criteria. + + + + Gets or sets whether the Find Panel is visible. + + true if the Find Panel is visible; otherwise, false. + + + + Forces an update to the control’s properties listed within the property grid at design time. + + + + + Gets or sets the width of the vertical lines that separate fixed columns from the others. + + An integer value which specifies the width of vertical lines, in pixels, that separate anchored columns from other columns. + + + + Gets or sets the focused column. + + The focused column. + + + + Fires immediately after focus has been moved from a column. + + + + + Gets or sets the focused node. + + A object representing the focused node. null (Nothing in Visual Basic) if no node is focused. + + + + Fires when focus moves from one node to another. + + + + + Returns the focused Tree List cell value. + + An Object that is the value of the focused Tree List cell. + + + + Sets focus to the New Item Row. + + + + + Gets or sets the height of the Summary Footer. + + An integer value that is the Summary Footer’s height. + + + + Forces the Tree List to finish its initialization. + + + + + Gets the collection of style format conditions. + + A object that represents the collection of style format conditions. + + + + Allows you to customize the Expression Editor embedded in the Edit Formatting Rule dialog. + + + + + Provides access to a collection of conditional formatting rules, which allow you to change the appearance of individual cells or rows based on specific conditions. + + A collection of conditional formatting rules. + + + + Collapses all expanded nodes within the XtraTreeList. + + + + + Expands all nodes within the XtraTreeList. + + + + + Expands all child nodes of a specific node. + + The to expand. + + + + Returns the list of checked nodes. + + The list of checked nodes. + + + + Returns the filtering value of an automatic filtering row cell that belongs to the specific Tree List column. + + A that owns an automatic filtering row cell, whose filtering value is to be retrieved. + An Object that is the filtering value. + + + + Gets the column by the bound field’s index within the data source. + + An integer value representing the zero-based index of the field whose bound column is sought for. + A object representing the column with the specified bound field index. + + + + Returns a column by its visible index. + + An integer value representing the column’s index among other visible columns. + A object or its descendant representing a column displayed at the position specified among other visible columns. null (Nothing in Visual Basic) if there is no column at the specified position. + + + + Gets the error description for the focused cell or the entire focused node. + + A object representing the column where the focused cell resides. null (Nothing in Visual Basic) to return the error description for the entire node. + A string value representing an error description. + + + + Gets the type of the error associated with the specified cell in the currently focused node. + + A object identifying the cell within the focused row. + An value that specifies the type of error. + + + + Returns the column header width that allows the content to be displayed in its entirety. + + An object that specifies the column for which to calculate the width. + An integer value that specifies the width. + + + + Provides the ability to assign editors to individual cells. + + + + + Provides the ability to assign custom style to individual cells. + + + + + Allows you to specify custom summary values when the control is displayed on-screen. + + + + + Returns a data row associated with the node specified. + + The object representing the node whose associated data row is to be obtained. + A data row associated with the node specified. null (Nothing in Visual Basic) if the node is not found. + + + + Returns a in the bound that contains data for the specified node. + + An integer value that specifies the node’s property. + An object that specifies a row of data in a . + + + + Gets the actual TreeListOptionsBehavior.EditorShowMode property value for this specific node. + + A Node whose editor show mode is to be determined. + A TreeListEditorShowMode enumeration value that specifies the way this node’s editor is invoked. + + + + Returns a in the bound that contains data for the focused node. + + A that specifies a row of data in a . + + + + Returns the display text of the currently focused Tree List cell. + + A String value that is the display text of the currently focused Tree List cell. + + + + Returns an in the bound data source that contains data for the focused node. + + An object that specifies a row of data in a data source. + + + + Returns the text displayed by a Tree List cell that resides within the currently focused data row. + + A that owns a cell whose visible text is to be obtained. + A String value that is the visible cell text. + + + + Returns the string/text displayed in the specified cell in the focused node. + + The field name of a column that contains the cell. + The text displayed in the specified cell. + + + + Retrieves the value stored within the required cell of the currently focused row. + + A that specifies a column that owns a target cell. + An Object that is the cell value. + + + + Returns the value of the specified cell in the focused node. + + The field name of a column that contains the cell. + An object that specifies the cell’s value. null (Nothing in Visual Basic) if the specified cell was not found. + + + + Returns a summary value calculated against the specified group of nodes. + + A object which represents the column whose values are used for summary calculation. + A object which represents the nodes collection containing the nodes against which the summary is calculated. + An object which represents the summary value calculated against a group of nodes. + + + + Returns information on the current control at a specified point. + + A Point that represents a single (x,y) coordinate. + A object containing information on the control at a specified point. + + + + Returns the Tree List node located under the target coordinates. + + A Point structure that specifies coordinates. + A object that is the Tree List node located under the target coordinates. + + + + Returns the Tree List node located under the target coordinates. + + An Int32 value that specifies the horizontal coordinate of the tested location.. + An Int32 value that specifies the vertical coordinate of the tested location. + A object that is the Tree List node located under the target coordinates. + + + + Returns a node with the specified index among the visible nodes. + + A zero-based integer specifying the node’s index. + A object representing the node with the specified index. null (Nothing in Visual Basic) if the node with the specified index is not found. + + + + Allows you to display custom values within cells. This event is obsolete. Use the TreeList.CustomColumnDisplayText event instead. + + + + + Gets the specified node’s index. + + A object representing the node whose index is to be obtained. + An integer value representing the destination position of the node within its parent node’s child collection. -1 if the specified node is a null reference or doesn’t belong to any node collection. + + + + Returns a list of all nodes in the . + + A list of all nodes in the . + + + + Enables you to supply custom text for nodes’ preview sections. + + + + + Allows you to specify custom summary values when the control is printed. + + + + + Enables you to display custom text in preview sections when the control is printed. + + + + + Returns an in the bound data source that contains data for the specified node. + + An integer value that specifies the node’s property. + An object that specifies a row of data in a data source. + + + + Returns the text displayed by a specific Tree List cell. + + A that owns a cell whose text is to be returned. + A that owns a cell whose text is to be returned. + A String value that is the visible cell text. + + + + Returns the string/text displayed in the specified cell. + + A node that contains the cell. + The field name of a column that contains the cell. + The text displayed in the specified cell. + + + + Retrieves the value stored within the required cell. + + A object that specifies a row that owns a target cell. + A that specifies a column that owns a target cell. + An Object that is the cell value. + + + + Returns the value of the specified cell. + + A node that contains the cell. + The field name of a column that contains the cell. + An object that specifies the cell’s value. null (Nothing in Visual Basic) if the specified cell was not found. + + + + Returns informaiton on scroll annotations of the specified kind. + + A ScrollAnnotationKind enumeration value that specifies the kind of scroll annotations on which to return information. + An array of TreeListScrollAnnotationInfo objects that specify information on scroll annotations of the specified kind. + + + + Returns the list of currently selected cells. + + A <DevExpress.XtraTreeList.TreeListCell,> object that contains the cells currently selected. + + + + Returns the list of columns currently selected in the specified node. + + A node in which to locate the selected columns. + A list of columns currently selected in the specified node. + + + + Allows you to assign select images to nodes. + + + + + Gets the column involved in sorting by its index within the sort column collection. + + An integer value representing the zero-based index of the column within the sort column list. + A object representing the requested column. null (Nothing in Visual Basic) if the specified sort column index is negative or exceeds the last available index. + + + + Allows you to assign state images to nodes. + + + + + Returns a summary value calculated against all the Tree List nodes or against the root nodes only. + + A object which represents the column whose values are used for summary calculation. + true to calculate the summary against all the Tree List nodes; false to calculate a summary only against the root nodes. + An object which represents the summary value calculated against Tree List nodes. + + + + Returns a summary value calculated against all the Tree List nodes or against the root nodes only. + + A object which represents the column whose values are used for the summary calculation. + An object which represents the summary value calculated against the Tree List nodes. + + + + Returns the index of the specified node among the visible nodes. + + The object representing the node whose visible index is obtained. + An integer value specifying the position of the specified node among the visible nodes. + + + + This property is obsolete. Gets or sets the size of group buttons. + + An integer value specifying the size of group buttons in pixels. + + + + Indicates whether the focused node or at least a single cell within the focused node has an error assigned. + + true if the focused node has errors; otherwise, false. + + + + Gets a value indicating whether the Tree List control is focused. + + true if the Tree List has focus; otherwise, false. + + + + Fires immediately after a cell editor has been closed. + + + + + Closes the Customization Form. + + + + + Fires immediately after the Customization Form has been closed. + + + + + Switches the TreeList control from edit to browse mode without saving changes. + + + + + Hides the Find Panel. + + + + + Hides the animated Loading Panel indicating the data load process. + + + + + Gets or sets the column in which tree list nodes display their expand/collapse buttons. + + A object specifying the column in which tree list nodes display their expand/collapse buttons. + + + + Gets the summary node indent in the column displaying node collapse/expand buttons. + + An integer value specifying the indent in the column displaying node collapse/expand buttons. + + + + Gets the name of a field in the underlying data source whose tree list column displays the node expand/collapse buttons. + + A string value specifying the name of a field in the underlying data source whose tree list column displays the node expand/collapse buttons. + + + + Gets or sets the offset by which the Tree List is scrolled horizontally when the scrollbar buttons are clicked. + + An integer value specifying by how many pixels the Tree List is scrolled. + + + + Gets or sets a value specifying when the horizontal scrollbar should be displayed. + + A enumeration value specifying when the horizontal scrollbar should be displayed. + + + + Occurs when a user clicks an element inside an HTML-CSS template. + + + + + Occurs when a user double-clicks any element of an HTML-CSS template. + + + + + Occurs when a mouse pointer is over an element of an HTML-CSS template, and a mouse button is pressed. + + + + + Occurs when a mouse pointer moves while over an element of an HTML-CSS template. + + + + + Occurs when a mouse pointer leaves the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse pointer enters the bounds of an element within an HTML-CSS template. + + + + + Occurs when a mouse button pressed over an element of an HTML-CSS template is released. + + + + + Gets or sets a collection of images that can be embedded in column/band headers and cells using the image tag. + + An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection). + + + + A collection of HTML-CSS templates that can be applied to TreeList and Gantt UI elements. + + A collection of HTML-CSS templates. + + + + Fires when a hyperlink in a column or band header is activated. + + + + + Gets or sets the name of the field whose values represent select image indexes for corresponding nodes. + + A string value that specifies the name of the data field that stores image indexes. + + + + Imports the data to the Tree List from the specified stream. + + A object which the Tree List’s data is imported from. + + + + Imports the data to the Tree List from the XML file. + + A value that specifies the full path (including the file name and extension) to the file in XML format which data will be imported to the Tree List. + + + + For internal use. + + + + + Gets or sets the indicator panel‘s width. + + An integer value that specifies the width of the node indicator panel in pixels. + + + + Fires when a new node is about to be created in the New Item Row and allows you to initialize column values. + + + + + This method supports the internal infrastructure and is not intended to be called directly from your code. + + + + + Invalidates the specified band header. + + An object that specifies the band whose header is to be invalidated. + + + + Invalidates the band panel. + + + + + Invalidates the specified cell. + + A object representing the node that contains the cell to invalidate. + A object representing the column to which the invalidated cell belongs. + + + + Invalidates the header of the specified column. + + A object specifying the column whose header is to be invalidated. + + + + Invalidates the column header panel. + + + + + Invalidates the Filter Panel. + + + + + Invalidates the specified node. + + A object specifying the node to be invalidated. + + + + Invalidates all visible nodes and row footers. + + + + + Invalidates the node that corresponds to the specified view information. + + An object that contains view information about a tree list node. + + + + Invalidates the preview section in the specified node. + + The node whose preview section is to be invalidated. + + + + Invalidates scrollbar annotations, and causes them to be redrawn. + + + + + Invalidates the summary footer panel. + + + + + Fires when a node fails validation or when its data cannot be saved to the data source. + + + + + Enables you to handle exceptions raised as a result of assigning invalid values to cells. + + + + + This member supports the Tree List’s infrastructure and should not be used from your code. + + A object representing data for the TreeList.TreeListMenuItemClick event. + + + + Gets whether the specified node is an Automatic Filtering Row. + + A object for which to return whether it is an Automatic Filtering Row. + true if the specified node is an Automatic Filtering Row; otherwise, false. + + + + Returns whether the cell in the specified node and column is currently selected. + + A node that contains the required cell. + A column that contains the required cell. + true if the cell in the specified node and column is currently selected; otherwise, false. + + + + Checks whether or not the Filter Editor dialog is available for the specific Tree List column. + + A to check. + true if the Filter Editor is available; otherwise, false. + + + + Returns whether or not the Find Panel is currently visible. + + true if the Find Panel is currently visible; otherwise, false. + + + + Gets whether the current Tree List control functions as a part of a control. + + true if the current Tree List control functions as a part of a control; otherwise, false. + + + + Identifies whether the specified node is the New Item Row. + + The node. + true if the specified node is the New Item Row; otherwise, false. + + + + Indicates whether a specific is currently visible. + + A whose visibility is inspected. + true if a specific node is visible; otherwise, false. + + + + Gets whether the control is sending data to the print/export engine. + + true if the control is sending data to the print/export engine; otherwise, false. + + + + Gets whether the control can be printed or exported. + + true if the control can be printed or exported; otherwise, false. + + + + Returns whether the specified node is a root node. + + A object for which to return whether it is a root node. + true if the specified node is a root node; otherwise, false. + + + + Obtains the value determining whether the current control is in unbound mode. + + true, if the current control is in unbound mode, otherwise, false. + + + + Gets or sets the name of the key field that uniquely identifies records in the data source. + + The key identifier field name. + + + + Called when global changes are applied to the object. + + + + + Fires after a Tree List’s layout has been changed. + + + + + Occurs after a layout the version of which doesn’t match the current layout version used has been loaded from storage (a stream, xml file or system registry). + + + + + Gets or sets the version of the control’s layout. + + A string representing the version of the control’s layout. + + + + Gets or sets a value specifying the number of pixels by which the control’s content is scrolled horizontally. + + An integer value specifying the horizontal scrolling offset of the control’s content in pixels. + + + + Fires when the control’s content is scrolled horizontally. + + + + + Occurs when a control is displayed for the first time. + + + + + Gets or sets whether the animated Loading Panel indicating the data load process is displayed. + + true if the Loading panel is displayed; otherwise, false. + + + + In bound mode, prevents updates of the tree structure when adding and deleting nodes and changing nodes’ parents via the Tree List or data source, until the TreeList.UnlockReloadNodes method is called. + + + + + Scrolls the control’s content so that the specified column becomes visible on screen. + + The column to make visible on screen. + + + + Makes visible the specified via the parameter. + + The to make visible. + The found node’s index among visible nodes. + + + + Allows you to specify the height of individual preview sections in pixels. + + + + + Gets or sets the minimum allowed width of all the columns in a Tree List. + + An integer value that specifies the minimum width of columns, in pixels. + + + + Moves focus to the first node. + + A object representing the focused node. + + + + Moves focus to the last node within the current . + + A object representing the focused node. + + + + Moves focus to the last visible node within the current . + + A representing the focused node. + + + + Moves focus to the node following the currently focused one, while expanding collapsed nodes, when required. + + The newly focused node. + + + + Moves focus to the next visible node following the currently focused one. + + The newly focused node. + + + + Moves the specified via the sourceNode parameter to the TreeListNode.Nodes collection of the specified by the destinationNode parameter. + + The moved . + A accepting the moved one. + true if the destination node’s key field value is assigned to the parent field of the source node; otherwise false. + An Int32 value that specifies the position that the moved node occupies within the destination collection. + true, if the sourceNode was moved, otherwise, false. + + + + Moves the selected node to the specified node’s child collection. + + A object representing the node to be moved. + A object representing the node to whose child collection the node is moved. null (Nothing in Visual Basic) if the source node must be moved to the root nodes collection. + true, if the parent field value of the source node must be set to the key field value of the destination node; otherwise false. + true, if the node has been moved successfully, otherwise false. + + + + Moves the specified via the sourceNode parameter to the TreeListNode.Nodes collection of the specified by the destinationNode parameter. + + The moved . + A accepting the moved one. + true, if the sourceNode was moved, otherwise, false. + + + + Moves the objects specified via the sourceNodes parameter to the TreeListNode.Nodes collection of the specified by the destinationNode parameter. + + The moved objects. + A accepting the moved one. + true if the destination node’s key field value is assigned to the parent field of the source node; otherwise, false. + An Int32 value that specifies the position that the moved node occupies within the destination collection. + true, if the sourceNode was moved, otherwise, false. + + + + Moves focus to the node that precedes the currently focused one, while expanding collapsed nodes, when required. + + The newly focused node. + + + + Moves focus to the visible node preceding the currently focused one. + + The newly focused node. + + + + Moves the focus to the next node with a scrollbar annotation of the specified kind. + + A kind of scroll annotation. + true if the focus is successfully moved; otherwise, false. + + + + Moves the node focus to the parent node of the currently focused node. + + The parent node. null (Nothing in Visual Basic) if the currently focused node is the root node. + + + + Moves the focus to the previous node with a scrollbar annotation of the specified kind. + + A kind of scroll annotation. + true if the focus is successfully moved; otherwise, false. + + + + Provides access to the TreeList’s most recently used filters. + + A DevExpress.XtraTreeList.TreeListFilterInfoCollection object that stores the recently used filters. + + + + An integer value that specifies the value of the TreeListNode.Id property of the node that represents the New Item Row. + + + + + Gets or sets the text displayed in the New Item Row when it is not focused. + + A string value that specifies the text displayed in the New Item Row when it is not focused. + + + + Allows you to customize the appearance of individual cells. + + + + + Fires after the node’s property has changed. + + + + + Specifies the default HTML-CSS template for nodes. + + The default HTML-CSS template for nodes. + + + + Provides access to the collection of the TreeList’s root nodes. + + The collection of root nodes. + + + + Gets an object that enables you to perform specific operations on a set of nodes. + + A object used to perform predefined operations on a set of nodes. + + + + Fires when the Tree List control reloads all nodes. + + + + + Gets a CriteriaOperator-based filter applied to the and not associated with any column. + + A object that specifies a filter applied to the and not associated with any column. + + + + Gets the text representation of the filter applied to the and not associated with any column. + + The text representation of the filter that is not associated with any Tree List column. + + + + Provides access to the Tree List’s behavior options. + + A object which contains the Tree List’s behavior options. + + + + Provides access to the options that control row copy and paste operations. + + A object that provides access to the clipboard options. + + + + Provides access to a ‘s customization options. + + An object that specifies the TreeList’s customization options. + + + + Contains options that control the node drag-and-drop functionality. + + An object that provides drag-and-drop options. + + + + Provides access to options that specify the Edit Form — a modal form used to edit cell values. + + An object that contains Edit Form options. + + + + Provides access to the TreeList’s filtering options. + + A object containing the filtering options. + + + + Provides access to settings controlling the behavior and visibility of the Find Panel and its elements. + + A object that stores the settings controlling the behavior and visibility of the Find Panel and its elements. + + + + Contains options that are applied when you use HTML and CSS Templates to render nodes. + + An object with options that are applied when you use HTML and CSS templates to render nodes. + + + + Provides access to options that specify how a control’s layout is stored to and restored from a data store (a stream, xml file or the system registry). + + An object that provides the corresponding options. + + + + Provides access to the Tree List’s menu options. + + A object which provides the Tree List’s menu options. + + + + Provides access to a ‘s focus navigation options. + + An object that specifies the TreeList’s focus navigation options. + + + + Provides access to options that specify how the control is printed and exported. + + A object that contains the print and export options. + + + + Provides access to options specific to scrollbar annotations. + + Scrollbar annotation options. + + + + Provides access to the Tree List’s selection options. + + A object which contains the Tree List’s selection options. + + + + Provides access to the Tree List’s display options. + + A object which contains the Tree List’s display options. + + + + For internal use. + + + + + Gets an object that provides the painting functionality of the TreeList control. + + A TreeListPainter object implementing the control’s painting functionality. + + + + A DirectX-compatible event that replaces the standard Control.Paint event. + + + + + Gets or sets the data source field that identifies each record’s parent. + + The parent identifier field name. + + + + Fires after the query in the find panel changes. Allows you to create a filter condition based on the query and specify how to highlight results in the control. + + + + + Pastes data from clipboard in the Tree List according to the current ClipboardOptions.PasteMode and TreeListOptionsClipboard.PasteAsChildNodes settings (available from the TreeList.OptionsClipboard object). + + + + + Creates columns for all public fields in the bound data source. + + + + + Allows you to customize the default menus for column headers, row and footer summaries, nodes, and the empty area. + + + + + Posts edited cell’s value to the associated data source. + + + + + Gets or sets the name of the field that automatically provides data for preview sections. + + The name of the field whose values are displayed in preview sections. + + + + Gets or sets the left horizontal offset of content in preview sections. + + An integer value that specifies the left horizontal offset of content in a preview section, in pixels. -1 to use the corresponding skin setting(s). + + + + Gets or sets the number of text lines in preview sections. + + An integer value specifying the number of text lines within preview sections. + + + + Prints the data displayed in the control. + + + + + Opens the Print dialog that allows a user to print the data displayed in the control. + + + + + Fires repeatedly while the TreeList’s data is being printed/exported. + + + + + Allows you to restore certain settings previously saved in the layout. + + + + + Allows you to include certain settings in the layout when you save it. + + + + + Allows you to add custom-function-based filters (for example, ‘discount is more than 15%’) to Excel-style pop-up filter menus and/or the filter editor. + + + + + Allows you to assign HTML-CSS templates from the collection to an empty TreeList. + + + + + Allows you to assign HTML-CSS templates from the collection to nodes. + + + + + Forces the Tree List to invalidate its client area and immediately redraw itself. + + + + + Calls the Control.Refresh method, and optionally, clears all automatically calculated node heights. + + true, to recalculate node heights; otherwise, false. + + + + Refreshes the specified cell. + + A that contains the specified cell. + A object that is the column where the target cell resides. + + + + Updates the Tree List control to reflect changes made to a data source. + + + + + Refreshes the appearance and value of the active editor. + + true to update the edit value and appearance; false to update the appearance of the editor. + + + + Refreshes the specified node. + + A to be refreshed. + + + + Updates scrollbar annotations of the specified kind for the specified nodes, and causes them to be redrawn. + + The kind of scrollbar annotations to update. + An array of node handles. + + + + Updates scrollbar annotations of the specified kind, and causes them to be redrawn. + + The kind of scrollbar annotations to update. + + + + Resets the specified column’s auto filter row condition to its default value. + + A object that specifies the tree list column whose auto filter row condition are to be reset. + + + + Resets all columns’ auto filter row conditions to their default values. + + + + + Resets the specified columns’ auto filter row conditions to their default values. + + An array of objects that specify the tree list columns whose auto filter row conditions are to be reset. + + + + Restores the control’s layout stored at the specified system registry path, using the specified options. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the system registry path. + An object that specifies which Tree List options must be restored. +Or a OptionsLayoutBase.FullLayout object, to restore all the settings. + + + + Restores the control layout stored at the specified system registry path. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the system registry path. + + + + Loads the control’s layout from a stream, using the specified options. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A System.IO.Stream object from which the control’s settings are read. + An object that specifies which Tree List options must be restored. +Or, a OptionsLayoutBase.FullLayout object, to restore all the settings. + + + + Loads the control’s layout from a stream. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A System.IO.Stream object from which the control’s settings are read. + + + + Loads a control’s layout from the specified XML file, using the specified options. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the XML file from which control settings are read. + An object that specifies which Tree List options must be restored. +Or, a OptionsLayoutBase.FullLayout object, to restore all the settings. + + + + Loads a control’s layout from the specified XML file. + + Security note: Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization. + + A string value specifying the XML file from which control settings are read. + + + + Gets or sets the value that identifies root records in the data source. The root records must have the RootValue in the field the ParentFieldName property specifies. + + An object the root nodes contain in the field specified by the TreeList.ParentFieldName property. By default, an integer 0 value. + + + + Fires when a cell is clicked. + + + + + Fires when a row (node) is clicked. + + + + + Gets or sets the height of a node in pixels. + + An integer value specifying the height of a node in pixels. + + + + Fires when a row’s select image is clicked. + + + + + Fires when a row’s state image is clicked. + + + + + Saves the control’s layout to the specified system registry path, using the specified options. + + A string value specifying the system registry path. + An object that specifies which Tree List options must be saved. +Or, a OptionsLayoutBase.FullLayout object, to save all the settings. + + + + Saves the control’s layout to the specified system registry path. + + A string value, specifying the system registry path to which the layout is saved. + + + + Saves the control’s layout to a stream, using the specified options. + + A System.IO.Stream object to which the control’s layout is written. + An object that specifies which Tree List options must be saved. +Or, a OptionsLayoutBase.FullLayout object, to save all the settings. + + + + Saves the control’s layout to a stream. + + A System.IO.Stream object to which the control’s layout is written. + + + + Saves a control’s layout to a specified XML file, using the specified options. + + A string value specifying the XML file name. + An object that specifies which Tree List options must be saved. +Or, a OptionsLayoutBase.FullLayout object, to save all the settings. + + + + Saves a control’s layout to a specified XML file. + + A string value specifying the XML file name. + + + + Allows you to customize the scrollbar annotation color and alignment. + + + + + Selects all currently visible nodes. + + + + + Selects the cell in the specified node and column. + + A node in which to select the cell. + A column in which to select the cell. + + + + Selects cells in the specified range. + + A node containing the cell that specifies the starting point of the range to select. + A column containing the cell that specifies the starting point of the range to select. + A node containing the cell that specifies the end point of the range to select. + A column containing the cell that specifies the end point of the range to select. + + + + Selects cells in the specified range by data source IDs. + + An ID of the node containing the cell that specifies the starting point of the range to select. + A column containing the cell that specifies the starting point of the range to select. + An ID of the node containing the cell that specifies the end point of the range to select. + A column containing the cell that specifies the end point of the range to select. + + + + Fires when the user clicks a node’s select image. This event is obsolete. Use instead. + + + + + Gets or sets the source of select images for nodes. + + An object that represents the source of select images. + + + + Gets the collection of selected nodes. + + + + + Fires when node selection is changed. In v21.1 and higher, the event fires both in single and multiple node selection modes. + + + + + Allows you to specify whether users can select and unselect nodes. + + + + + Selects the specified node. This method is in effect only when multi-node selection is available. Otherwise, assign a required node to the FocusedNode property. + + A node to select. + + + + Selects nodes in the specified range. + + A node that specifies the starting point of the range to select. + A node that specifies the end point of the range to select. + + + + Selects nodes in the specified range by data source IDs. + + An ID of the node that specifies the starting point of the range to select. + An ID of the node that specifies the end point of the range to select. + + + + Assigns a required value to a automatic filtering row cell owned by a specific Tree List column. + + A that owns the target cell. + An Object that is the filtering value. + A enumerator value that is the filtering condition. + + + + Sets an error description and an error type for the specified cell within the focused node. + + A that identifies the cell to which an error is set. + A string value representing an error description. An empty string to clear the assigned error. + An value that specifies the type of the error. Error types correspond to specific error icons. + + + + Sets an error description for a cell within the focused node or for the entire focused node. + + A object representing a column that contains an error cell. null (Nothing in Visual Basic) if the error description should be assigned to the entire focused node. + A string value representing an error description. An empty string to clear the assigned error. + + + + Moves the specified column to the specified position among visible columns belonging to the same band. + + An object that specifies the column to be moved. + The zero-based index of the row where the specified column should be moved. This value is assigned to the TreeListColumn.RowIndex property. + The zero-based index of the column within a band row where the specified column should be moved. This value is assigned to the TreeListColumn.ColumnIndex property. + + + + Sets the options provided by the TreeList.OptionsBehavior property to their default values. + + + + + Sets the options provided by the TreeList.OptionsCustomization property to their default values. + + + + + Sets the options provided by the TreeList.OptionsNavigation property to their default values. + + + + + Sets the options provided by the TreeList.OptionsView property to their default values. + + + + + Sets the options provided by the TreeList.OptionsPrint property to their default values. + + + + + Activates automatic row height adjustment. + + + + + Sets the options provided by the TreeList.OptionsSelection property to their default values. + + + + + Sets focus to a specific node within the current control. + + The node to set focus on. + The index of the focused node among visible nodes. + + + + Assigns a value to the specified column within the currently focused data row. + + A that owns the cell to which the required value will be assigned. + An Object that is the value to be assigned. + + + + Assigns the required value to a cell within the focused Tree List node. + + A String value that identifies the data source field with which a target cell’s column is associated. + An Object that is the value to be assigned. + + + + Assigns the required value to the focused Tree List cell. + + An Object that is the value to be assigned to the focused cell. + + + + Sets the node’s check state. Allows you to set the check state for child and parent (if all child nodes are checked or unchecked) nodes. + + A object whose check state is to be changed. + A CheckState enumeration value that specifies the check state. + true to set the check state of child and parent nodes; otherwise, false. + + + + Sets the node’s check state to the specified value. + + A object whose check state is to be changed. + A CheckState value that specifies the node’s new check state. + + + + Moves the specified node to a new position within its parent node’s child collection. + + A object representing the node to be moved. + An integer value representing the destination position of the node within its parent node’s child collection. + + + + Sets the TreeList cell to a specific value. + + A that specifies the target cell’s row. + A that specifies the target cell’s column. + An Object that is the value to be assigned to the target cell. + + + + Sets the TreeList cell to a specific value. + + A that specifies the target cell’s row. + A String value that identifies the data source field with which a target cell’s column is associated. + An Object that is the value to be assigned to the target cell. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + When users select multiple nodes, the selection starts from the selection anchor, rather than the currently focused node. Call the SetSelectionAnchor method to set this selection anchor. + + The node to set the selection anchor on. + The column to set the selection anchor on. + + + + Invokes the condition selector’s menu for the specific column in the automatic filtering row. + + A for which the condition selector menu should be invoked. + + + + Gets or sets a value that specifies which column cells display editor buttons. + + A value that specifies which column cells display editor buttons. + + + + Displays a node context menu for the focused cell. + + true if the context menu was displayed; otherwise, false. + + + + Displays the Customization Form. + + + + + Displays the Customization Form at the specified point. + + The position of the Customization Form‘s top-left corner, in screen coordinates. + + + + Fires immediately after the Customization Form has been displayed. + + + + + Opens the Edit Form for the specific Tree List node. If the node parameter is not set, the Edit Form opens for the currently focused node. + + A node that should be opened in the Edit Form. + + + + Switches the TreeList control to edit mode. + + + + + Moves focus to the specified cell in the focused node and switches the TreeList control to edit mode (activates the cell’s editor). + + The field name in a data source. + + + + Shows the Filter Editor. + + A object to which a filter is applied in the Filter Editor. + + + + Shows the filter pop-up menu for the specified column. + + A object specifying the column for which to show the filter pop-up menu. + + + + Fires before a pop-up filter menu is displayed. Allows you to customize the value checklist. + + + + + Allows you to customize a column’s dropdown calendar before it is displayed. + + + + + Allows you to hide specific filtering conditions from the “Filters” tab of the Excel-style Filter Dropdown. + + + + + Fires before a pop-up filter menu is displayed. Allows you to customize the value list. + + + + + Displays the Find Panel. + + + + + Fires before the is switched to edit mode. + + + + + Shows the animated Loading Panel indicating the data load process. + + + + + Fires immediately after a cell editor has been invoked. + + + + + Opens the Print Preview window, which displays commands in bars. + + + + + Opens the Print Preview window, which displays commands in a ribbon. + + + + + Allows you to customize the default menus for column headers, row and footer summaries, nodes, and the empty area. + + + + + Invokes an Expression Editor that enables editing an expression for the specified unbound column. + + A that represents an unbound column whose expression will be edited in the Expression Editor. + + + + Sorts the specified node’s children against a column. Allows you to sort root nodes. + + The node whose children need to be sorted. Null, to sort root nodes. + The sort column. + The sort order. + true, to sort nodes recursively; otherwise, false. + + + + Sorts the specified node’s children using the specified IComparer object. Allows you to sort root nodes. + + The node whose children need to be sorted. Null, to sort root nodes. + The object that compares Tree List nodes. + true, to sort nodes recursively; otherwise, false. + + + + Gets the number of columns involved in sorting. + + An integer value representing the number of columns involved in sorting. + + + + Starts an incremental search for the specified string. + + The text to locate. + + + + Fires before a sorting operation is started. + + + + + Gets the control’s current state. + + A enumeration member, indicating the Tree List’s current state. + + + + Fires after the Tree List’s state has changed. + + + + + Fires when the user clicks a node’s state image. This event is obsolete. Use instead. + + + + + Gets or sets the source of state images for nodes. + + An object that represents the source of state images. + + + + Stops the incremental search, if there is one currently in progress. + + + + + Allows you to replace the applied filter with another filter. + + + + + This member supports the internal infrastructure. + + The default is true. + + + + Gets or sets the index of the top visible node. + + An integer value specifying the zero-based index of the top visible node. + + + + Fires when the control’s content is scrolled vertically. + + + + + Gets or sets the vertical scroll position of the top node. + + A System.Int32 value that specifies the vertical scroll position of the top node + + + + Gets or sets the width of the level indents. + + An integer which specifies the width of the level indents. The property’s minimum value is 12. + + + + Gets or sets the style (solid, dash, etc.) of lines indicating the node hierarchy in the row indent area. This property is obsolete, use TreeListOptionsView.TreeLineStyle instead. + + A enumerator value specifying the style for displaying tree lines. + + + + Gets a value indicating whether the current control is being unloaded from memory. + + true if the control is being unloaded from memory; otherwise, false. + + + + Provides the ability to perform custom handling of a context menu item click. + + + + + Gets or sets the only column whose values are displayed by the control in TreeView visual style. + + The only column whose values are displayed by the control in TreeView visual style. + + + + Gets or sets the only field whose values are displayed by the control in TreeView visual style. + + The name of the field whose values are displayed by the control in TreeView visual style. + + + + Fires after an Expression Editor has been created for an unbound column. + + + + + Unchecks all nodes in the Tree List control. + + + + + Updates the control’s tree structure after the TreeList.LockReloadNodes method call, and updates it immediately. + + + + + Discards selection of the cell in the specified intersection. + + A node in which to unselect the cell. + A column in which to unselect the cell. + + + + Discards selection of the specified range of cells. + + A node containing the cell that specifies the starting point of the range to unselect. + A column containing the cell that specifies the starting point of the range to unselect. + A node containing the cell that specifies the end point of the range to unselect. + A column containing the cell that specifies the end point of the range to unselect. + + + + Discards selection of the specified range of cells by data source IDs. + + An ID of the node containing the cell that specifies the starting point of the range to unselect. + A column containing the cell that specifies the starting point of the range to unselect. + An ID of the node containing the cell that specifies the end point of the range to unselect. + A column containing the cell that specifies the end point of the range to unselect. + + + + Discards selection of the specified node. + + A node to unselect. + + + + Discards selection of nodes in the specified range. + + A node that specifies the starting point of the range to unselect. + A node that specifies the end point of the range to unselect. + + + + Discards selection of nodes in the specified range by data source IDs. + + An ID of the node that specifies the starting point of the range to unselect. + An ID of the node that specifies the end point of the range to unselect. + + + + This member supports the internal infrastructure, and is not intended to be used directly from your code. + + + + + Gets or sets whether to use the advanced Customization Form. + + True to use the advanced customization form; False to use the default customization form. + + + + Gets or sets whether the DirectX Hardware Acceleration is enabled for this Tree List control. + + A DefaultBoolean enumerator value that specifies whether or not this control employs the DirectX Hardware Acceleration. +The DefaultBoolean.Default value is equivalent to DefaultBoolean.True if the static WindowsFormsSettings.ForceDirectXPaint method was called, or to DefaultBoolean.False otherwise. + + + + Gets or sets whether the control is painted grayed out, when it’s in the disabled state. + + true if the control is painted grayed out, when it’s in the disabled state; otherwise, false + + + + Gives you the ability to specify whether a modified node’s data is valid, and if this node can lose focus. + + + + + Fires when an editor is validated. + + + + + Gets or sets a value specifying when the Tree List’s vertical scrollbar is visible. + + A enumeration value specifying when the vertical scrollbar is visible. + + + + Gets the control’s view/display information. + + A TreeListViewInfo object providing view information on all the Tree List’s elements. + + + + Gets or sets whether the control renders its data in a default Tree List style (cell borders, column headers and indicator panel are visible by default) or Tree View style (no cell borders, column headers and indicator panel). + + A value that specifies the control’s visual style. + + + + This event allows you to initialize cells (and optionally the check state) of the processed node, when populating the Tree List control with data dynamically. + + + + + Allows you to supply root and child nodes, when populating the Tree List control with data dynamically. + + + + + Allows changes that are made to node cells and check state to be stored. + + + + + Gets the number of visible columns within the Tree List. + + An integer value representing the number of visible columns. + + + + Gets the collection of visible columns. + + A VisibleColumnsList object storing visible columns. + + + + Gets the number of rows which are not hidden within collapsed groups. + + An integer value representing the number of rows which are not hidden within collapsed groups. + + + + Lists the values that identify cells within which animation is enabled. + + + + + Animation is enabled within all visible cells. + + + + + Animation is enabled within the focused node. + + + + + The same value as the TreeListAnimationType.AnimateAllContent option. + + + + + Animation is disabled. + + + + + Provides the appearance settings used to paint the Tree List. + + + + + Initializes a new instance of the class with the specified owner. + + An object which implements the IAppearanceOwner interface (the or descendant) that will own the created collection. + + + + Gets the appearance settings used to paint band headers. + + An object that specifies the appearance settings used to paint band headers. + + + + Gets the appearance settings used to paint the caption. + + An object that provides the appearance settings used to paint the Tree List’s caption. + + + + Gets or sets the appearance of the hint text displayed within an empty Customization Form. + + A object that contains corresponding style settings. + + + + Gets the appearance settings used to paint the Tree List’s empty space. + + An object that provides the appearance settings used to paint the Tree List’s empty space. + + + + Gets the appearance settings used to paint even nodes. + + An object that provides the appearance settings used to paint even nodes. + + + + Gets the appearance settings used to paint the Filter Panel. + + An object that contains appearance settings used to paint the filter panel. + + + + Gets the appearance settings used to paint the fixed lines. + + A object that provides the appearance settings used to paint the fixed lines. + + + + Gets the appearance settings used to paint the currently focused cell. + + An object that provides the appearance settings used to paint the currently focused cell. + + + + Gets the appearance settings used to paint the currently focused node. + + An object which provides the appearance settings used to paint the currently focused node. + + + + Gets the appearance settings used to paint the summary footer. + + An object that provides the appearance settings used to paint the summary footer. + + + + Gets the appearance settings used to paint node expand buttons. + + An object that provides the appearance settings used to paint node expand buttons. + + + + Gets the appearance settings used to paint the group footer. + + An object that provides the appearance settings used to paint the group footer. + + + + Gets the appearance settings used to paint the column header and node indicator panels. + + An object that provides the appearance settings used to paint the column header and node indicator panels. + + + + Gets the appearance settings used to paint the column header panel‘s background. + + An object that specifies the appearance settings used to paint the column header panel’s background. + + + + Gets the appearance settings used to paint the selected node(s) when the Tree List isn’t focused. + + An object that provides the appearance settings used to paint the selected node(s) when the Tree List isn’t focused. + + + + Gets the appearance settings used to paint the horizontal lines. + + An object that provides the appearance settings used to paint the horizontal lines. + + + + Gets the appearance settings used to paint hot-tracked nodes. + + The appearance settings used to paint hot-tracked nodes. + + + + Gets the appearance settings used to paint odd nodes. + + A object that provides the appearance settings used to paint odd nodes. + + + + Gets the appearance settings used to paint preview sections. + + An object that provides the appearance settings used to paint preview sections. + + + + Gets the appearance settings used to paint data cells within Tree List nodes. + + An object that provides the appearance settings used to paint data cells within Tree List nodes. + + + + Gets the appearance settings used to paint the selected nodes. + + An object that provides the appearance settings used to paint the selected nodes. + + + + Gets the appearance settings specifying column and band separator background color. + + An object that provides the appearance settings used to paint column and band separators. + + + + Provides access to appearance settings that are used to paint the New Item Row. + + An object that specifies appearance settings that are used to paint the New Item Row. + + + + Gets the appearance settings used to paint the tree lines. + + An object that provides the appearance settings used to paint the tree lines. + + + + Gets the appearance settings used to paint the vertical lines. + + A object that provides the appearance settings used to paint the vertical lines. + + + + Enumerates the best fit operaton modes. + + + + + The Full mode is the default one if any of the following statements is true: + + + + + + Otherwise, the default mode is Fast. + + + + + In this mode, the checks only the number of characters within each cell. This is a less time-consuming calculation mode, at a cost of calculation precision. + + + + + In this mode, best fit calculations consider character widths, in-place editor settings and events. Such calculations may require more time but guarantee the most accurate results. + + + + + Enumerates values that specify how users edit values in the tree list cells. + + + + + The mode is not explicitly specified. Enables the mode. + + + + + Edit Form — cells values are edited in a modal form. + + + + + + In-place Editors — cell values are edited directly in the tree list cells. + + + + + + Represents a class that contains information about what is located at a specific point within the control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A TreeListHitTest object containing information about the visual element located under the test point. This value is assigned to the TreeListHitInfo.HitTest property. + + + + Gets the band located under the test point. + + An object specifying the band that contains the test point. + + + + Gets the limits for the Tree List element that contains the test point. + + A structure representing the element’s bounding rectangle. + + + + Gets the column located under the test point. + + The object representing the column that contains the test point. + + + + Gets the visual element located under the test point. + + A enumeration value identifying the type of visual element at the test point. + + + + Gets an object containing information about the visual element located under the test point. + + A DevExpress.XtraTreeList.TreeListHitTest object containing information about the visual element located under the test point. + + + + Gets whether a point is over the blank column header. + + true if a point is over the blank column header; otherwise, false. + + + + Gets whether a point is over a column header, or filter button. + + true if a point is over a column header or filter button; otherwise, false. + + + + Gets whether a point is over a column header panel (a header, blank header, button, filter button, the column header panel itself or its edge). + + true if a point is over a column header panel; otherwise, false. + + + + Gets whether a point is over the Filter Panel (the filter, the check box disabling the filter, the ‘Close Filter’, ‘Edit Filter’, or ‘MRU Filters’ button). + + true if a point is over the Filter Panel; otherwise, false. + + + + Gets whether a point is over a row’s cell, expand button, select image, state image, indicator cell, preview section, or the row’s area not occupied by any of these elements. + + true if a point belongs to a row; otherwise, false. + + + + Gets whether a point is over a cell. + + true if a point is over a cell; otherwise, false. + + + + Gets whether a point belongs to a row’s check box. + + true if a point belongs to a row’s check box; otherwise, false. + + + + Gets whether a point is over a row (group) footer. + + true if a point is over a row (group) footer; otherwise, false. + + + + Gets whether a point is over an area that separates a row from its indicator cell. + + true if a point is over an area that separates a row from its indicator cell; otherwise, false. + + + + Gets whether a point is over a row indicator cell. + + true if a point is over a row indicator cell; otherwise, false. + + + + Gets whether a point is over a row’s select image. + + true if a point is over a row’s select image; otherwise, false. + + + + Gets whether a point is over a row’s state image. + + true if a point is over a row’s state image; otherwise, false. + + + + Gets the coordinates of the point under the mouse cursor relative to the Tree List control. + + A object specifying the mouse cursor’s position relative to the upper left corner of a Tree List control. + + + + Gets the node located under the test point. + + A object representing a node located under the test point. + + + + Provides data for the event. + + + + + Initializes a new instance of the class with specified settings. + + A new node. + The parent node. This value is assigned to the property. + + + + Initializes a new instance of the class with specified settings. + + An object that specifies the tree list node being created. + + + + Gets the parent node. + + The parent node. null (Nothing in Visual Basic) if the new node is the root node. + + + + Sets the specified value in the specified column. + + An object that identifies the tree list column (a object, field name, column’s absolute index, or object). + A value for the column. + + + + Provides data for the TreeList.ShowTreeListMenu event. + + + + + Initializes a new instance of the class. + + A DevExpress.XtraTreeList.Menu.TreeListMenu object representing the Tree List’s context menu. This value is assigned to the Menu property. + A structure that contains the current mouse pointer coordinates. This value is assigned to the Point property. + true if the context menu will be displayed; otherwise false. This value is assigned to the Allow property. + + + + Represents a method that will handle the TreeList.ShowTreeListMenu event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Provides data for the TreeList.TreeListMenuItemClick event. + + + + + Initializes a new instance of the class with the specified settings. + + A column that owns the menu. + An enumeration value that specifies the clicked condition. + A DXMenuItem associated with the clicked condition. + + + + Initializes a new instance of the class. + + A object representing the column for which the context menu has been activated. This value is assigned to the TreeListMenuItemClickEventArgs.Column property. + true if the summary footer’s menu item has been clicked; false if either the column header or row footer’s menu item has been clicked. This value is assigned to the TreeListMenuItemClickEventArgs.IsFooter property. + A enumeration value specifying the type of summary which is about to be applied to the column. This value is assigned to the TreeListMenuItemClickEventArgs.SummaryType property. + The format string applied to the column’s summary value. This value is assigned to the TreeListMenuItemClickEventArgs.SummaryFormat property. + A object representing the clicked menu item. This value is assigned to the TreeListMenuItemClickEventArgs.MenuItem property. + + + + Returns the clicked Automatic Filtering Row condition. + + An enumeration value that specifies the clicked Automatic Filtering Row condition. + + + + Gets the column against whose header or footer the context menu has been activated. + + A object representing the column for which the context menu has been activated. + + + + Gets or sets a value indicating whether default menu item click processing is prohibited. + + true if default menu item click processing is not performed; otherwise false. + + + + Gets whether an item in the footer summary’s context menu has been clicked. + + true if the footer summary’s menu item has been clicked; otherwise, false. + + + + Gets the clicked menu item. + + A object representing the clicked menu item. + + + + Gets the type of menu whose item has been clicked. + + A enumeration value that specifies the type of menu whose item has been clicked. + + + + Gets or sets the format of summary value displayed for the column. + + The format string applied to the column’s summary value. + + + + Gets or sets the summary type which is about to be applied to the column. + + A enumeration value specifying the type of summary which is about to be applied to the column. + + + + Represents a method that will handle the TreeList.TreeListMenuItemClick event. + + The event sender (typically the control). + A object that contains data related to the event. + + + + Represents a collection of selected nodes for the Tree List control. + + + + + Creates a collection of selected nodes for a specific object. + + A object to which the collection belongs. + + + + Adds the specified node to the collection of selected nodes. + + A object representing the node to be added. + + + + Selects the specified collection of nodes. + + An object implementing the IEnumerable interface which holds the collection of nodes to be selected. + + + + Toggles the specified node between the selected and deselected states. + + A object representing the node to be selected or deselected. + + + + Prevents selection updates until the TreeListMultiSelection.EndSelect method is called. + + + + + Enables selection updates after the TreeListMultiSelection.BeginSelect method call, but doesn’t force an immediate update. + + + + + Clears the current selection. + + + + + Specifies whether a specific node is in the collection of selected nodes. + + The object to check. + true if a node is in the collection of selected nodes; otherwise, false + + + + Gets the number of items (selected nodes) in this collection. + + An integer value that specifies the number of selected nodes. + + + + Enables selection updates after calling the TreeListMultiSelection.BeginSelect method and forces an immediate update. + + + + + Returns an enumerator that iterates through the collection. + + An IEnumerator<TreeListNode> object that can be used to iterate through the collection. + + + + Determines the index of a specific object in the collection of selected nodes. + + A object for which to return the position within the collection of selected nodes. + The zero-based index of a specific object in the collection of selected nodes. + + + + Gets whether selection updates are prevented. + + true if selection updates are prevented; otherwise, false. + + + + Gets a object from the collection of selected nodes referenced by the specified index. + + The index of the selected node to retrieve. + A selected node referenced by the specified index. + + + + Unselects the specified node, and removes it from the current collection. + + A node to remove from the current collection. + true if the specified node is successfully removed; otherwise, false. + + + + Removes the node at the specified index of the current collection, and unselects it. + + The zero-based index of the node in the current collection to be removed. + + + + Selects the cell in the specified column of the specified node (row). + + A node in which to select the cell. + A column in which to select the cell. + + + + Selects the cells in the specified column of the specified nodes (rows). + + Nodes in which to select the cells. + A column in which to select the cells. + + + + Selects the specified node (row). + + A node to select. + + + + Selects the specified nodes (rows). + + A collection of nodes to select. + + + + Removes all nodes from the collection of selected nodes and then adds a specific node to the collection. + + The node to select. + + + + Removes all nodes from the collection of selected nodes and then adds a specific group of nodes to the collection. + + A group of nodes to select. + + + + Unselects all nodes, and removes them from the current collection. + + + + + Unselects the cell in the specified column of the specified node (row). + + A node in which to unselect the cell. + A column in which to unselect the cell. + + + + Discards selection of the specified node. + + A node to unselect. + + + + Unselects cells in the specified columns of the specified nodes (rows). + + A collection of nodes in which to unselect cells. + A column in which to unselect cells. + + + + Unselects the specified nodes (rows). + + A collection of nodes to unselect. + + + + Enumerates values that specify whether the New Item Row is displayed at the top or bottom of the list. + + + + + The New Item Row is displayed at the bottom of the list. + + + + + + The New Item Row is not displayed. + + + + + The New Item Row is displayed at the top of the list. + + + + + + Provides behavior options for Tree List controls. + + + + + Initializes a new instance of the class with the specified settings. + + A object to which the current behavior settings belong. + + + + Gets or sets whether node check states can be specified dynamically - using the TreeList.VirtualTreeGetCellValue/TreeList.VirtualTreeSetCellValue events, and IVirtualTreeListData.VirtualTreeGetCellValue/VirtualTreeSetCellValue interface methods. + + true if node check states can be specified dynamically - via dedicated events and methods; false if these events/methods are only fired to get/set node values. + + + + Gets or sets whether an end-user can copy selected nodes to the Clipboard via the CTRL+C shortcut. + + true if an end-user can copy selected nodes to the Clipboard via a keyboard shortcut; otherwise, false. + + + + Gets or sets whether to use animation effects when expanding/collapsing nodes using the expand button. + + True, to use animation effects; otherwise, False; Default uses the WindowsFormsSettings.AnimationMode static (Shared in VB) setting. + + + + Gets or sets whether a node is expanded/collapsed after it has been double clicked. + + true if the node is expanded/collapsed after it has been double clicked; otherwise, false. + + + + Gets or sets whether end-users can locate nodes by typing the desired column value. This property is obsolete for versions 17.1 and newer. + + true if incremental searching is allowed; otherwise, false. + + + + Gets or sets whether an end-user can switch a node to the indeterminate check state with a mouse click. + + true if an end-user can switch a node to the indeterminate check state; otherwise, false. + + + + Gets or sets whether smooth pixel-based vertical scrolling is enabled for nodes. + + A value that specifies whether smooth pixel-based vertical scrolling is enabled for nodes. + + + + Gets or sets whether a column can be hidden by dragging it away from the Column Header Panel, even if the Customization Form is not open. + + true if a column can be hidden by dragging it away from the Column Header Panel, even if the Customization Form is not open; otherwise, false + + + + Gets or sets whether child nodes are automatically checked/unchecked when a parent node is checked/unchecked and vice versa. + + true if child nodes are automatically checked/unchecked when a parent node is checked/unchecked and vice versa; otherwise, false. + + + + Copies all the settings from the options object passed as the parameter to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the node’s parent field value is automatically set to the key field value of its parent node. + + true if the node’s parent field value is automatically set to the key field value of its parent node; otherwise, false. + + + + Gets or sets whether a newly added node is automatically focused. + + true if a newly added node is automatically focused; otherwise, false. + + + + Gets or sets a value specifying whether horizontal navigation keys move focus to the next/previous node when the current node’s last/first cell is focused. + + true if horizontal navigation keys can move focus between nodes; otherwise, false. + + + + Gets or sets whether the height of each node is automatically adjusted to completely display the contents of its cells. + + true to enable automatic calculation of the heights of nodes; otherwise, false. + + + + Gets or sets whether columns should be automatically created for all the fields in the underlying data source when the Tree List doesn’t contain any columns. + + true if the columns are created automatically when the Tree List doesn’t contain any columns; otherwise, false. + + + + Gets or sets whether the Tree List is automatically scrolled to the focused node on sorting. + + true if the Tree List is automatically scrolled to the focused node on sorting; otherwise, false. + + + + Gets or sets whether activating a cell editor using the or ENTER or F2 keys selects the entire editor’s content. + + true to select the entire cell’s content when editing starts; otherwise, false. + + + + Gets or sets whether end-users are allowed to clone nodes using drag-and-drop. + + true, to allow end-users to clone nodes using drag-and-drop; otherwise, false. + + + + Gets or sets whether the active editor is automatically closed when the Tree List loses focus. + + true if the active editor is automatically closed when the Tree List loses focus and any changes made to the edited cell’s content are saved; otherwise, the cell’s editor isn’t closed. + + + + Gets or sets whether column captions are copied to the Clipboard. + + true if column captions are copied to the Clipboard along with selected nodes; false if only selected nodes are copied to the Clipboard. + + + + Gets or sets whether data is copied to the Clipboard with the hierarchy information included or in a flat form. + + true if data is copied to the Clipboard with the hierarchy information included; otherwise, false. + + + + Gets or sets whether end-users are allowed to move or copy nodes using drag-and-drop. + + true, to allow end-users to move or copy nodes using drag-and-drop; otherwise, false. + + + + Gets or sets whether users are allowed to invoke cell editors. + + true if users are allowed to invoke cell editors; otherwise, false. + + + + Gets or sets how users edit cell values: directly in the tree list cells or in a modal form. + + A value that specifies how users edit cell values. + + + + Gets or sets how cell editors are invoked by the mouse (click, double click, etc.). + + A TreeListEditorShowMode enumeration value that specifies how cell editors are invoked by the mouse. + + + + Gets or sets whether nodes can be filtered. + + true, to allow nodes to be filtered; otherwise, false. The property’s default value is false in version 16.2 and older. The property’s default value is true in version 17.1 and newer. See Version Compatibility: Default Property Values to learn more. + + + + Gets or sets whether the ENTER key can be used to move focus between cells. + + true to enable focus moving using the ENTER key; otherwise, false. + + + + Gets or sets whether collapsed nodes are automatically expanded when the node currently being dragged is hovered over them. + + true if collapsed nodes are automatically expanded when a dragged node is hovered over them; otherwise, false. + + + + Gets or sets whether collapsed nodes are automatically expanded if they match the filter criteria. + + true if collapsed nodes are automatically expanded if they match the filter criteria; otherwise, false. + + + + Gets or sets a value that specifies whether collapsed nodes are expanded to display the node if it matches the search criteria. + + true to expand the collapsed node if it matches the search criteria; otherwise, false. + + + + Gets or sets whether and how hyperlinks in column and band headers are activated. + + A value that specifies whether and how hyperlinks in column and band headers are activated. + + + + Gets or sets whether an in-place editor is automatically activated when a cell is clicked. + + true if an in-place editor is automatically activated when a cell is clicked; otherwise, false. + + + + Gets or sets whether the tree list automatically updates the row order and row visibility after a cell value is changed. + + true if the tree list automatically updates the row order and row visibility after a cell value is changed; otherwise, false. + + + + This property is obsolete. Use the TreeListOptionsSelection.KeepSelectedOnClick property instead. + + true, if row selection persists when a user clicks on a selected row’s cell; false, if the control deselects rows (except for the clicked row) on a cell click. + + + + Gets or sets whether end-users can navigate through cells using arrow keys while editing. + + true to allow end-users to navigate through cells using arrow keys while editing; otherwise, false. + + + + Gets or sets whether the TreeList.PopulateColumns method creates columns bound to the fields the TreeList.KeyFieldName, TreeList.ParentFieldName and TreeList.ImageIndexFieldName properties specify. + + true to create service columns when calling the TreeList.PopulateColumns method; false, service columns are not created. + + + + Gets or sets whether the current is read-only. + + true if the current is read-only; otherwise, false. + + + + Gets or sets whether end-users are allowed to change the heights of nodes. + + true to allow end-users to change the heights of nodes; otherwise, false. + + + + Gets or sets whether a cell’s editor is activated when the mouse button is released from a click within the cell. + + true to activate a cell’s editor when the mouse button is released from a click within the cell; false to activate a cell’s editor when the mouse button is initially pressed within the cell. + + + + Gets or sets whether tooltips are displayed for the cells and column headers. + + true, to show tooltips for the cells and column headers with truncated content; otherwise, false. + + + + Gets or sets whether the regions occupied by the scroll bars and active cell editors are considered to be a part of the Tree List’s area. + + true if the regions occupied by the scroll bars and active cell editors are considered to be a part of the Tree List’s area; otherwise, false. + + + + Gets or sets the type of unbound expression editor that end-users can utilize to modify expressions for unbound columns owned by this Tree List control. + + An enumeration value that specifies the type of unbound expression editor that end-users can utilize to modify expressions for unbound columns owned by this Tree List control. + + + + Gets or sets whether the TAB/SHIFT + TAB key combinations move focus to the next/previous node cell or to the next/previous control in the tab order. + + true if the TAB/SHIFT+TAB key combinations are processed by the Tree List; otherwise, false. + + + + Provides Clipboard options for the . + + + + + Initializes a new instance of the class with the specified settings. + + true, to enable copying formatted data; otherwise, false. This property value is used to initialize the ClipboardOptions.ClipboardMode property. + + + + Gets or sets whether an end-user can copy selected TreeList nodes to the Clipboard. + + A DefaultBoolean enumerator value that specifies if an end-user can copy selected TreeList nodes to the Clipboard. + + + + Copies settings from the specified object to the current object. + + An object whose setting will be copied to the current object + + + + Gets or sets whether selected nodes are copied to the clipboard with or without indents that reflect node hierarchy levels. + + A DefaultBoolean enumerator value that specifies whether the nodes are copied to the clipboard with indents. The Default value is equivalent to True. + + + + Gets or sets whether pasted rows are added as the focused node’s children or siblings. This option is in effect when the ClipboardOptions.PasteMode setting (available from TreeList.OptionsClipboard) is set to Append. + + True and Default if pasted data is added as the focused node’s children; False if pasted data is added as the focused node’s siblings. + + + + Provides access to a ‘s customization options. + + + + + Initializes a new instance of a class. + + + + + Gets or sets whether and how column/band headers are sorted within the advanced Customization Form. + + A value that specifies whether and how column/band headers are sorted in the advanced Customization Form. + + + + Specifies whether bands can be moved by dragging their headers. + + true if bands can be moved to a new position; otherwise, false. + + + + Specifies whether bands can be resized by dragging the right edge of their headers. + + true if bands can be resized; otherwise, false. + + + + Specifies whether bands can be moved between parents. + + true if bands can be moved between parents; otherwise, false. + + + + Specifies whether columns can be moved between bands. + + true if columns can be moved between bands; otherwise, false. + + + + Specifies whether columns can be moved by dragging their headers. + + true if columns can be moved to a new position; otherwise, false. + + + + Specifies whether columns can be resized by dragging the right edge of their headers. + + true if columns can be resized; otherwise, false. + + + + Gets or sets whether users can use pop-up filter menus and filter panel. This property does not disable filtering data in code. + + true if pop-up filter menus are enabled; otherwise, false. + + + + Specifies whether bands and individual columns can be hidden by dragging their headers away from the header panel. + + true if bands and columns can be hidden by dragging their headers away from the header panel; otherwise, false. + + + + Gets or sets whether or not end-users can sort data within this Tree List. + + true if sorting is enabled; otherwise, false. + + + + Copies all settings from the options object passed as a parameter. + + An object whose settings are assigned to the current object. + + + + Gets or sets whether to focus the Customization Form when it is invoked. + + true to focus the Customization Form when it is invoked; otherwise, false. + + + + Gets or sets whether the Customization Form displays the search box that allows end-users to find columns and bands. + + true if the Customization Form displays the search box; otherwise, false. + + + + Gets or sets whether or not the Customization Form can stick to the parent form or screen edges. + + A SnapMode enumeration value that specifies whether or not the Customization Form can stick to the parent form or screen edges. By default, the WindowsFormsSettings.CustomizationFormSnapMode global setting is inherited. + + + + Specifies whether hidden bands are displayed in the Customization Form. + + true if hidden bands are displayed in the Customization Form; otherwise, false. + + + + Gets or sets whether to use the advanced Customization Form. + + True, to use the advanced Customization Form; Default or False, to use the default Customization Form. + + + + Contains options that control node drag-and-drop functionality. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the current TreeList accepts nodes being dragged from another TreeList control. + + true if the current TreeList accepts nodes being dragged from another TreeList control; otherwise, false. + + + + Copies settings of the specified object to the current object. + + An object whose settings are copied to the current object. + + + + Gets or sets whether end-users are allowed to clone nodes using drag-and-drop. + + true, to allow end-users to clone nodes using drag-and-drop; otherwise, false. + + + + Gets or sets the amount of time (in milliseconds) before the node is expanded when another node is dragged over it. + + An integer value specifying the delay (in milliseconds) from the time a dragged node begins hovering over a collapsed node to the time that the node is expanded. + + + + Gets or sets whether single or multiple nodes can be dragged simultaneously, or whether the drag-and-drop functionality is disabled. + + Nodes drag-and-drop mode. + + + + Gets or sets how the SHIFT key modifies the drop position of a dragged node. + + A value that specifies how the SHIFT key modifies the drop position of a dragged node. + + + + Gets or sets whether collapsed nodes are automatically expanded when the node currently being dragged is hovered over them. + + true if collapsed nodes are automatically expanded when a dragged node is hovered over them; otherwise, false. + + + + Gets or sets whether nodes being dragged are dropped in the order they are in the tree list, or in the order they are selected. + + true if nodes are dropped in the order they are selected; false if nodes are droped in the order they are in the tree list. + + + + Contains options that specify the Edit Form. + + + + + Initializes a new class instance. + + + + + Assigns the specified object’s property values to the current object’s corresponding properties. + + The object whose property values to assign to the current object’s corresponding properties. + + + + Gets or sets whether changes in the Edit Form are immediately applied to cells in the Tree List or only when the user closes the Edit Form. + + Default or Direct if changes in the Edit Form are immediately applied to cells in the Tree List; otherwise, Cached. + + + + Gets or sets a custom Edit Form. + + A object that specifies the custom Edit Form. + + + + Gets or sets the number of layout columns in the Edit Form. + + An value that specifies the number of layout columns in the Edit Form. + + + + Gets or sets a custom caption for the Edit From. Use field names in braces {} to display field values in the caption. + + A value that specifies the Edit From’s caption. + + + + Gets or sets the width of the Edit Form. + + An value that specifies the width of the Edit Form. + + + + Gets or sets whether the Edit Form is opened with a double-click. + + Default or True if the Edit Form is opened with a double-click; otherwise, False. + + + + Gets or sets whether the Edit Form is opened with the Enter key. + + Default or True if the Edit Form is opened with the Enter key; otherwise, False. + + + + Gets or sets whether the Edit Form is opened with the F2 key. + + Default or True if the Edit Form is opened with the Enter key; otherwise, False. + + + + Provides filtering options for the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified settings. + + + + + Gets or sets whether or not the automatic filtering row for this TreeList control displays buttons, using which end-users can change the default filter operator for each column. + + A DefaultBoolean enumerator value that specifies whether or not the automatic filtering row should display the condition selector. + + + + Gets or sets whether the pop-up filter menus display the most recently used filter list. + + true if the pop-up filter menus display recently used filter values; otherwise, false. + + + + Gets or sets whether the Filter Editor can be used to build complex filter criteria. + + true to allow using the Filter Editor; otherwise, false. + + + + Gets or sets whether the TreeList’s MRU Filter List is enabled. + + true if the MRU Filter List is enabled; otherwise false. + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether pop-up filter menus are displayed in the Excel or Classic style. + + A value that specifies whether pop-up filter menus are displayed in the Excel or Classic style. + + + + Gets or sets the maximum number of values in the pop-up filter menus. + + An integer value that specifies the maximum number of values in the pop-up filter menus. + + + + Gets or sets how an end-user can edit expressions in the Filter Editor and Format Rule Expression Editor. + + A value. + + + + Gets or sets whether collapsed nodes are automatically expanded if they match the filter criteria. + + true if collapsed nodes are automatically expanded if they match the filter criteria; otherwise, false. + + + + Gets or sets whether users can create filters against properties of the List type. + + A value that specifies whether users can create filters against properties of the List type. + + + + Gets or sets whether the Filter Editor allows you to display, create and edit custom expressions—expressions that cannot be converted to Filter Editor nodes. + + A value that specifies whether the Filter Editor allows you to display, create and edit custom expressions. + + + + Gets or sets whether to use a pop-up menu instead of a combo box that supports the incremental search to edit operators and operands in the Filter Editor. + + true, to use a pop-up menu to edit operators and operands in the Filter Editor; false, to use a combo box. + + + + Gets or sets whether to show only the filtered nodes or also show their parent and child nodes. Additionally, you can enable the ExpandNodesOnFiltering property to automatically expand filtered nodes. + + A enumeration value that specifies how filtered nodes are shown. + + + + Gets or sets the maximum number of items in the pop-up filter menu‘s most recently used filter list. + + An integer that specifies the maximum number of items in the MRU filter list. + + + + Gets or sets the MRU Filter List capacity. + + An integer value that specifies the MRU Filter List capacity. + + + + Gets or sets the maximum number of items the TreeList’s MRU Filter List can display at once. + + An integer value that determines the maximum number of items that the TreeList’s MRU Filter List can display at once. + + + + Gets or sets whether the value checklist in the pop-up filter menu shows all available values or only those that are currently displayed in the column. + + true if the pop-up filter menu shows all available values; otherwise, false. + + + + Gets or sets whether the value list in the pop-up filter menu shows all available values or only those that are currently displayed in the column. + + true if the pop-up filter menu shows all available values; otherwise, false. + + + + Gets or sets whether to show custom function-based filters. + + True to show custom function-based filters; False to not show them; Default to enable/disable custom function-based filters depending on the global setting. + + + + Contains options that are applied when you use HTML and CSS Templates to render nodes. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether users can select the contents of HTML tags. + + Specifies the initial value of the user-select CSS property for all HTML elements. The DefaultBoolean.True value sets this property to auto, the DefaultBoolean.False and DefaultBoolean.Default values set it to none. + + + + Copies all settings from the options object passed as the parameter and assigns them to the current object. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets the average height of templated nodes used to calculate the scroll position (in pixel-by-pixel scrolling mode). + + An integer value that specifies the average height of templated nodes, in pixels. + + + + Gets or sets whether to raise the event when the focused node changes. + + true to raise the event when the focused node changes; otherwise, false. + + + + Provides menu options for Tree List controls. + + + + + Initializes a new instance of the class. + + + + + Copies all settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether end-users can invoke the column header context menu. + + true if end-users can right-click column headers to invoke their context menus; otherwise, false. + + + + Gets or sets whether end-users can invoke footer context menus. + + true if end-users can click the summary footer and group footers to invoke their context menus; otherwise, false. + + + + Gets or sets whether users can invoke a context menu with a right-click on a node. + + true if users can invoke a context menu with a right-click on a node; otherwise, false. + + + + Gets or sets whether the node context menu contains commands that allow users to add new nodes. + + , if the context menu displays the Add Node and Add Child Node commands; , if not; , if the visibility depends on the New Item Row visibility. + + + + Gets whether the ‘Show Auto Filter Row’ check item is displayed within the Column Header Context Menu. + + true if the ‘Show Auto Filter Row’ check item is available within a column header’s menu; otherwise, false. + + + + Gets or sets whether the Conditional Formatting menu is available in a column’s context menu at runtime, allowing end-users to apply style formats to columns. + + true if the conditional formatting menu is available at runtime; otherwise, false. + + + + Gets or sets whether to show the expand/collapse commands in the context menu invoked with a right-click on a node. + + true, to show the expand/collapse commands in the context menu invoked with a right-click on a node; otherwise, false. + + + + Gets whether the “Show/Hide Footer“ item is displayed within the Column Header Context Menu. + + true if the “Show/Hide Footer“ item is available within a column header’s menu; otherwise, false. + + + + Contains options that control node navigation functionality. + + + + + Initializes a new instance of the class. + + + + + Copies settings of the specified object to the current object. + + An object whose settings are copied to the current object. + + + + Gets or sets whether a newly added node is automatically focused. + + true if a newly added node is automatically focused; otherwise, false. + + + + Gets or sets whether the Left Arrow and Right Arrow keyboard keys move focus to the next/previous node when the current node’s last/first cell is focused. + + true if horizontal navigation keys can move focus between nodes; otherwise, false. + + + + Gets or sets whether the ENTER key can be used to move focus between cells. + + true, to enable focus moving using the ENTER key; otherwise, false. + + + + Gets or sets whether end-users can navigate through cells using Arrow keys while editing cells. + + true, to allow end-users to navigate through cells using arrow keys while editing cells; otherwise, false. + + + + Gets or sets whether focus always moves horizontally to the sibling cell or with respect to how columns are arranged in bands. + + true if focus always moves horizontally to the sibling cell; otherwise, false. + + + + Gets or sets whether focus always moves vertically to the sibling cell or with respect to how columns are arranged in bands. + + true if focus always moves vertically to the sibling cell; otherwise, false. + + + + Gets or sets whether the TAB/SHIFT + TAB key combinations move focus to the next/previous node cell or to the next/previous control in the tab order. + + true if the TAB/SHIFT+TAB key combinations are processed by the Tree List; otherwise, false. + + + + Provides options that control how the Tree List control is printed and exported. + + + + + Initializes a new instance of the class. + + + + + Gets or sets whether the print/export progress window contains the Cancel button, which allows an end-user to cancel the current print/export operation. + + true if the print/export progress window contains the Cancel button; otherwise, false. + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the height of nodes is calculated automatically when the Tree List is printed. + + true if the height of nodes is calculated automatically; otherwise, false. + + + + Gets or sets whether columns are automatically stretched when the tree list is printed so that it fits the page’s width (except margins). + + true to force the Tree List to fit the printed page horizontally; otherwise, false. + + + + Gets or sets whether the Tree List is printed with all its nodes expanded. + + true to expand all the collapsed nodes when the Tree List is printed; otherwise, false. + + + + Gets or sets whether band headers are printed/exported. + + true if band headers are printed/exported; otherwise, false. + + + + Gets or sets whether to print node check boxes. + + true, to print built-in check boxes; otherwise, false. + + + + Gets or sets whether the tree indents are painted using the appearance settings of their corresponding nodes when the Tree List is printed. + + true to paint the tree indents using the appearance settings of their corresponding nodes; otherwise, false. + + + + Gets or sets whether to print the nearest (leftmost) vertical gridlines in the column that displays the node expand buttons. + + true, to print the nearest vertical gridlines; otherwise, false. + + + + Gets or sets whether left-fixed columns and bands are repeated on every print/export page. + + A Boolean value that specifies whether left-fixed columns and bands are repeated on every print/export page + + + + Gets or sets whether horizontal lines are printed. + + true to print horizontal lines; otherwise, false. + + + + Gets or sets whether the state and select images are printed. + + true to print node images; otherwise, false. + + + + Gets or sets whether column headers are printed. + + true to print column headers; otherwise, false. + + + + Gets or sets whether preview sections are printed. + + true, to print preview sections; otherwise, false. + + + + Gets or sets whether the summary footer is printed. + + true to print the summary footer; otherwise, false. + + + + Gets or sets whether group footers are printed. + + true to print group footers; otherwise, false. + + + + Gets or sets whether the tree lines are printed. + + true to print tree lines; otherwise, false. + + + + Gets or sets whether the node expand buttons are printed. + + true to print node expand buttons; otherwise, false. + + + + Gets or sets whether vertical lines are printed. + + true to print vertical lines; otherwise, false. + + + + Gets or sets whether a separate window is used to indicate print/export progress. + + true if a separate window is used to indicate print/export progress; otherwise, false. + + + + Gets or sets whether the print appearances are used when the Tree List is printed and exported. + + true to use the print appearances; otherwise, false. + + + + Provides selection options for Tree List controls. + + + + + Initializes a new instance of the class. + + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the appearance settings for the focused cell are enabled. + + true if the appearance settings for the focused cell are enabled; otherwise, false. + + + + Gets or sets whether the appearance settings for the focused node are enabled. + + true if the appearance settings for the focused node are enabled; otherwise, false. + + + + Gets or sets whether the appearance settings for the hovered (hot-tracked) node are enabled. is equivalent to . + + , if the appearance settings for the hovered (hot-tracked) node are enabled; otherwise, or . + + + + Gets or sets whether the focused style is applied to the focused cell only or to all the cells except for the focused one. + + true to apply the focused style to the focused cell only; otherwise, false. + + + + Gets or sets whether row selection persists when a user clicks on a selected row’s cell. + + true, if row selection persists when a user clicks on a selected row’s cell; false, if the control deselects rows (except for the clicked row) on a cell click. + + + + Gets or sets whether multiple nodes can be selected. + + true to allow multiple nodes to be selected; otherwise, false. + + + + Gets or sets whether multiple selection is made by node or by cell. + + A DevExpress.XtraTreeList.TreeListMultiSelectMode enumeration value that specifies whether multiple selection is made by node or by cell. + + + + Gets or sets whether nodes are focused when right-clicked. + + true if nodes are focused when right-clicked; otherwise, false. + + + + Gets or sets whether nodes can be selected via the node indicator when the Tree List is in multiple selection mode. + + true if nodes can be selected via the node indicator; otherwise, false. + + + + Provides view options for the Tree List controls. + + + + + Initializes a new instance of the class. + + A object specifying the control associated with the options being created. + + + + Gets or sets whether columns within a band can be arranged in multiple rows. + + true if columns can be arrange in multiple rows; otherwise, false. + + + + Gets or sets whether column and node icons of the current should be painted with the foreground color of these columns or nodes. + + true if column and node icons of the current should be painted with the foreground color of these columns or nodes; otherwise, false. + + + + Gets or sets whether HTML formatting can be applied to column and band captions. + + true if HTML formatting can be applied to column and band captions; otherwise, false. + + + + Gets or sets the animation mode, which identifies cells for which animation is enabled. + + Animation mode. + + + + Copies all the settings from the options object passed as the parameter. + + A descendant whose settings are assigned to the current object. + + + + Gets or sets whether the Tree List automatically calculates the number of text lines in preview sections depending upon their contents. + + true if the Tree List automatically calculates the preview sections height; otherwise, false. + + + + Gets or sets whether the widths of column is automatically adjusted so that the total width of all the columns matches the Tree List’s width. + + true to enable the column auto width feature; otherwise, false. + + + + Gets or sets the number of data nodes whose content is processed to apply best fit to columns. + + An integer value specifying the number of data nodes that are processed to apply best fit to columns. + + + + Gets or sets whether column best-fit resizing operations should prioritize precision or speed. + + A enumeration value, such as Full or Fast, that specifies whether column best-fit resizing operations should prioritize precision or speed. + + + + Gets or sets a value specifying which nodes take part in calculations when applying best fit to columns. + + A DevExpress.XtraTreeList.TreeListBestFitNodes enumeration value that specifies which nodes take part in calculations when applying best fit to columns. + + + + Gets or sets whether cell error icons are taken into account when calculating the “best width” for columns. + + A value that specifies whether cell error icons are taken into account when calculating the “best width” for columns. + + + + Gets or sets whether all TreeList nodes should display check boxes, radio buttons, or neither. + + A DevExpress.XtraTreeList.DefaultNodeCheckBoxStyle enumerator value that specifies the type of content displayed by nodes. The Default value means nodes display neither check boxes, nor radio buttons. + + + + Gets or sets whether the column header height is automatically adjusted to fit wrapped column captions. + + A value that specifies whether the column header height is automatically adjusted to fit wrapped column captions. + + + + Gets or sets whether even nodes are painted using the appearance settings provided by the TreeListAppearanceCollection.EvenRow property. + + true to paint even nodes using the appearance settings provided by the TreeListAppearanceCollection.EvenRow property; false to use the appearance settings provided by the TreeListAppearanceCollection.Row property. + + + + Gets or sets whether odd nodes are painted using the appearance settings provided by the TreeListAppearanceCollection.OddRow property. + + true to paint odd nodes using the appearance settings provided by the TreeListAppearanceCollection.OddRow property; false to use the appearance settings provided by the TreeListAppearanceCollection.Row property. + + + + Gets or sets whether node expand buttons are vertically centered relative to the node height. This setting is in effect when node previews are visible. + + true if node expand buttons are vertically centered relative to the node height; false if the expand buttons are top-aligned (centered relative to the regular data cell height). + + + + Gets or sets the display style of filter conditions in the Filter Panel, MRU Filter List and built-in Filter Editor. + + The display style of filter conditions in the Filter Panel and built-in Filter Editor. When the FilterCriteriaDisplayStyle property is set to Default, the actual display style is specified by the static WindowsFormsSettings.FilterCriteriaDisplayStyle property. + + + + Gets or sets a value that specifies how the focus rectangle is painted. + + A value that specifies the focus rectangle style. + + + + Gets or sets the display style of column filter buttons. + + A enumeration value which specifies the display style of column filter buttons. + + + + Gets or sets whether the row that allows users to add new nodes at the root level is displayed at the top or bottom of the list, or not displayed. + + A value that specifies the New Item Row position. + + + + Resets the TreeListOptionsView.ShowIndentAsRowStyle property to its default value. + + + + + Gets or sets whether root TreeList nodes should draw check boxes, radio buttons, or neither. + + A DevExpress.XtraTreeList.NodeCheckBoxStyle enumeration value that specifies whether root TreeList nodes should draw check boxes, radio buttons, or neither. The Default value means root nodes follow the global TreeListOptionsView.CheckBoxStyle setting. + + + + Gets or sets whether to show row images in row indents or in row cells. + + Default or InIndent to display row images in the indent area; InCell to display row images in row cells. + + + + Returns whether the TreeListOptionsView.ShowIndentAsRowStyle property should be serialized. + + true if the TreeListOptionsView.ShowIndentAsRowStyle property should be serialized; otherwise, false. + + + + Gets or sets whether the Automatic Filtering Row is displayed. + + true to display the Auto Filter Row; otherwise false. + + + + Gets or sets whether band headers are displayed. + + true if band headers are displayed; otherwise, false. + + + + Gets or sets whether bands are displayed. + + A value that specifies whether the band panel is displayed. + + + + Gets or sets whether the expand buttons are displayed. + + true to display the expand buttons; otherwise, false. + + + + Gets or sets whether the caption panel is displayed at the top of the control. + + true if the caption is displayed above the ; otherwise, false. + + + + Gets or sets whether nodes display check boxes. + This member is obsolete. Use the TreeListOptionsView.CheckBoxStyle, TreeListOptionsView.RootCheckBoxStyle and TreeListNode.ChildrenCheckBoxStyle properties instead. + + true, to show check boxes; otherwise, false. + + + + Gets or sets whether column headers are displayed. + + true to display column headers; otherwise, false. + + + + Gets or sets a value that specifies when the Filter Panel is shown. + + A enumeration value which specifies when the filter panel is shown. + + + + Gets or sets whether the tree list displays the nearest (leftmost) vertical gridlines in the column that displays the node expand buttons. + + true, to display the nearest vertical gridlines; otherwise, false. + + + + Gets or sets whether a focus frame is displayed around the focused cell. + + true, to display a focus frame around the focused cell; otherwise, false. + + + + Gets or sets whether to draw horizontal gridlines in a column displaying the node expand buttons for the entire width of the column, including tree indents. + + Default to do not draw the gridlines for hierarchy indentations in the first column, and draw otherwise. True or False to draw or do not draw, respectively, the gridlines regardless of the number of the column. + + + + Gets or sets whether horizontal lines are displayed. + + true to display horizontal lines; otherwise, false. + + + + Gets or sets whether tree indents are painted using the appearance settings of their corresponding nodes. + + true to paint tree indents using the appearance settings of their corresponding nodes; otherwise, false. + + + + Gets or sets whether the node indicator panel is displayed. + + true to display the node indicator panel; otherwise, false. + + + + Gets or sets whether preview sections are displayed. + + true, to display preview sections; otherwise, false. + + + + Gets or sets whether the root level node indent is visible. + + true, to display the root level node indent; otherwise, false. + + + + Gets or sets whether group footers are displayed. + + true, to display group footers; otherwise, false. + + + + Gets or sets whether the summary footer is displayed. + + true to display the summary footer; otherwise, false. + + + + Gets or sets whether to show the node hierarchy lines in the row indent area. + + True to display the node hierarchy lines; False to not; Default uses the currently applied skin settings. + + + + Gets or sets whether vertical lines are displayed. + + true to display vertical lines; otherwise, false. + + + + Gets or sets the style (solid, dash, etc.) of lines indicating the node hierarchy in the row indent area. + + A enumeration value specifying the line style. + + + + Gets or sets a value that specifies how the control indicates data operations performed in a background thread. + + A enumeration value, such as Panel or Indicator, that specify how the control indicates data operations performed in a background thread. The Default is Panel. + + + + Provides the appearance settings used to paint the elements in a Tree List when it’s printed and exported. + + + + + Initializes a new instance of the class. + + A object or its descendant which represents the Tree List that will own the created collection. + + + + Gets the appearance settings used to paint the band headers when the is printed. + + An object that specifies the appearance settings used to paint the band headers when the is printed. + + + + Gets the appearance settings used to paint the caption when the Tree List is printed. + + An object which provides the appearance settings used to paint the caption when the Tree List is printed. + + + + Gets the appearance settings used to paint the even nodes when the Tree List is printed. + + A object which provides the appearance settings used to paint the even nodes when the Tree List is printed. + + + + Gets the appearance settings used to paint the summary footer when the Tree List is printed. + + A object which provides the appearance settings used to paint the summary footer when the Tree List is printed. + + + + Gets the appearance settings used to paint the group footer when the Tree List is printed. + + A object which provides the appearance settings used to paint the group footer when the Tree List is printed. + + + + Gets the appearance settings used to paint the column headers when the Tree List is printed. + + A object which provides the appearance settings used to paint the column headers when the Tree List is printed. + + + + Gets the appearance settings used to paint the horizontal and vertical lines when the Tree List is printed. + + A object which provides the appearance settings used to paint the horizontal and vertical lines when the Tree List is printed. + + + + Gets the appearance settings used to paint the odd nodes when the Tree List is printed. + + A object which provides the appearance settings used to paint odd nodes when the Tree List is printed. + + + + Gets the appearance settings used to paint preview sections when the Tree List is printed. + + A object which provides the appearance settings used to paint preview sections when the Tree List is printed. + + + + Gets the appearance settings used to paint the data cells when the Tree List is printed. + + A object which provides the appearance settings used to paint the data cells when the Tree List is printed. + + + + Contains values indicating all the available states for the Tree List. + + + + + The band button is clicked. + + + + + A band’s header is being dragged. The band’s OptionsBand.AllowMove option must be enabled to allow a band header to be dragged. + + + + + A band’s header is pressed. + + + + + A band’s right edge is being dragged to change the band’s width. The band’s OptionsBand.AllowSize option must be enabled to allow such resizing. + + + + + Multiple cells are being selected. + + + + + The column button is clicked. + + + + + A column’s header is being dragged. The column’s TreeListOptionsColumn.AllowMove option must be enabled to allow column header dragging. + + + + + A column’s header is pressed. + + + + + A column’s right edge is being dragged to change the column’s width. The column’s TreeListOptionsColumn.AllowSize option must be enabled to allow such resizing. + + + + + The Tree List is currently in design mode. + + + + + A cell editor is currently active. + + + + + An incremental search is being performed. + + + + + Multiple nodes are being selected using drag and drop. The TreeListOptionsSelection.MultiSelect option must be set to true to enable this feature. + + + + + A node is being dragged. See TreeListOptionsDragAndDrop.DragNodesMode. + + + + + A node is currently pressed. + + + + + A node is being resized by an end-user. This implies that the node’s edge is being dragged. This operation is only available for nodes whose TreeListOptionsBehavior.ResizeNodes option is enabled. + You can prevent the node from being resized by enabling the TreeListOptionsBehavior.AutoNodeHeight option. + + + + + An external object, not one of the Tree List’s elements, is being dragged from outside over the Tree List control. + + + + + The Tree List is in its normal state. No specific action is being performed by an end-user. + + + + + Provides data for the TreeList.ValidateNode event. + + + + + Creates a new object. + + A object representing the node. This value is assigned to the NodeEventArgs.Node property. + + + + Gets or sets the error description. + + A string representing the error description. + + + + Gets or sets whether the node’s validation succeeds. + + true to accept node cell values; otherwise, false. + + + + Represents a method that will handle the TreeList.ValidateNode event. + + The event sender (the object which raised the event). + A object that contains event data. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the Tree List control which fires the event. + A object that contains data for the event. + + + + Provides data for the TreeList.VirtualTreeGetCellValue event. + + + + + Initializes a new instance of the class. + + A business object to be processed. This value is assigned to the VirtualTreeGetCellValueInfo.Node property. + A object that represents the currently processed column. This value is assigned to the VirtualTreeGetCellValueInfo.Column property. + + + + Gets or sets the current cell value (when VirtualTreeGetCellValueInfo.IsCheckState is false) or the node’s check state (when VirtualTreeGetCellValueInfo.IsCheckState is true). + + Initially this property is set to a null reference. Use this property to supply data for the current cell or provide the node check state. + + + + Gets the column that contains the cell currently being processed. + + A object that represents the column currently being processed. + + + + Gets whether the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is currently fired for you to provide a node’s check state. + + true if the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is fired for you to provide a node’s check state; false if this event/method is fired for you to provide a node’s cell values. + + + + Gets an instance of the business object being currently processed. + + An object being currently processed. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the Tree List control which fires the event. + A object that contains data for the event. + + + + Provides data for the TreeList.VirtualTreeGetChildNodes event. + + + + + Initializes a new instance of the class. + + A business object to be processed. This value is assigned to the VirtualTreeGetChildNodesInfo.Node property. + + + + Gets or sets the collection of children for the currently processed business object. + + Initially this property is set to a null reference. Use this property to assign a list of children for the currently processed object. + + + + Gets an instance of the business object being currently processed. + + An object being currently processed. + + + + Represents the method for handling events which take a object as a parameter. + + The event source. This identifies the Tree List control which fires the event. + A object that contains data for the event. + + + + Provides data for the TreeList.VirtualTreeSetCellValue event. + + + + + Initializes a new instance of the class. + + The current cell’s old value. This value is assigned to the VirtualTreeSetCellValueInfo.OldCellData property. + The new value to be assigned to the current cell. This value is assigned to the VirtualTreeSetCellValueInfo.NewCellData property. + A business object to be processed. This value is assigned to the VirtualTreeSetCellValueInfo.Node property. + A object that represents the currently processed column. This value is assigned to the VirtualTreeSetCellValueInfo.Column property. + + + + Gets or sets whether the new value is discarded. + + true if the new value is discarded; otherwise, false. + + + + Gets the column that contains the cell being currently processed. + + A object that represents the column being currently processed. + + + + Gets whether the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is currently fired for you to save a node’s check state. + + true if the TreeList.VirtualTreeGetCellValue event/IVirtualTreeListData.VirtualTreeGetCellValue interface method is fired for you to save a node’s check state; false if this event/method is fired for you to save a node’s cell values. + + + + Gets the new cell value (when VirtualTreeSetCellValueInfo.IsCheckState is false) or the node’s new check state (when VirtualTreeSetCellValueInfo.IsCheckState is true). + + An object that represents the new cell value/node’s new check state. + + + + Gets an instance of the business object being currently processed. + + An object being currently processed. + + + + Gets the current cell’s old data. + + An object that specifies the current cell’s old data. + + + \ No newline at end of file diff --git a/BitgetApi/bin/Debug/Newtonsoft.Json.dll b/BitgetApi/bin/Debug/Newtonsoft.Json.dll new file mode 100644 index 0000000..341d08f Binary files /dev/null and b/BitgetApi/bin/Debug/Newtonsoft.Json.dll differ diff --git a/BitgetApi/bin/Debug/Newtonsoft.Json.xml b/BitgetApi/bin/Debug/Newtonsoft.Json.xml new file mode 100644 index 0000000..2c981ab --- /dev/null +++ b/BitgetApi/bin/Debug/Newtonsoft.Json.xml @@ -0,0 +1,11363 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/BitgetApi/obj/Debug/.NETFramework,Version=v4.7.2.AssemblyAttributes.cs b/BitgetApi/obj/Debug/.NETFramework,Version=v4.7.2.AssemblyAttributes.cs new file mode 100644 index 0000000..3871b18 --- /dev/null +++ b/BitgetApi/obj/Debug/.NETFramework,Version=v4.7.2.AssemblyAttributes.cs @@ -0,0 +1,4 @@ +// +using System; +using System.Reflection; +[assembly: global::System.Runtime.Versioning.TargetFrameworkAttribute(".NETFramework,Version=v4.7.2", FrameworkDisplayName = ".NET Framework 4.7.2")] diff --git a/BitgetApi/obj/Debug/BitgetApi.MainForm.resources b/BitgetApi/obj/Debug/BitgetApi.MainForm.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.MainForm.resources differ diff --git a/BitgetApi/obj/Debug/BitgetApi.Properties.Resources.resources b/BitgetApi/obj/Debug/BitgetApi.Properties.Resources.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.Properties.Resources.resources differ diff --git a/BitgetApi/obj/Debug/BitgetApi.csproj.AssemblyReference.cache b/BitgetApi/obj/Debug/BitgetApi.csproj.AssemblyReference.cache new file mode 100644 index 0000000..8441e32 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.csproj.AssemblyReference.cache differ diff --git a/BitgetApi/obj/Debug/BitgetApi.csproj.CoreCompileInputs.cache b/BitgetApi/obj/Debug/BitgetApi.csproj.CoreCompileInputs.cache new file mode 100644 index 0000000..b2760d6 --- /dev/null +++ b/BitgetApi/obj/Debug/BitgetApi.csproj.CoreCompileInputs.cache @@ -0,0 +1 @@ +d5ff6d03fc217fbfad1931b3790d8220d6d9c91db92e859321096b373c80c2f3 diff --git a/BitgetApi/obj/Debug/BitgetApi.csproj.FileListAbsolute.txt b/BitgetApi/obj/Debug/BitgetApi.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..5b11a73 --- /dev/null +++ b/BitgetApi/obj/Debug/BitgetApi.csproj.FileListAbsolute.txt @@ -0,0 +1,36 @@ +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\BitgetApi.exe.config +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\BitgetApi.exe +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\BitgetApi.pdb +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Data.Desktop.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Data.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Drawing.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Printing.v23.2.Core.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Utils.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraEditors.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraLayout.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraTreeList.v23.2.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\Newtonsoft.Json.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Pdf.v23.2.Core.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Pdf.v23.2.Drawing.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Sparkline.v23.2.Core.dll +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Data.Desktop.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Data.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Drawing.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Printing.v23.2.Core.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Utils.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraEditors.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraLayout.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.XtraTreeList.v23.2.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\Newtonsoft.Json.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Pdf.v23.2.Core.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Pdf.v23.2.Drawing.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\bin\Debug\DevExpress.Sparkline.v23.2.Core.xml +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.csproj.AssemblyReference.cache +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.MainForm.resources +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.Properties.Resources.resources +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.csproj.GenerateResource.cache +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.exe.licenses +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.csproj.CoreCompileInputs.cache +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.csproj.Up2Date +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.exe +D:\Project\Bitget API\BitgetApi\BitgetApi\obj\Debug\BitgetApi.pdb diff --git a/BitgetApi/obj/Debug/BitgetApi.csproj.GenerateResource.cache b/BitgetApi/obj/Debug/BitgetApi.csproj.GenerateResource.cache new file mode 100644 index 0000000..c175e88 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.csproj.GenerateResource.cache differ diff --git a/BitgetApi/obj/Debug/BitgetApi.csproj.Up2Date b/BitgetApi/obj/Debug/BitgetApi.csproj.Up2Date new file mode 100644 index 0000000..e69de29 diff --git a/BitgetApi/obj/Debug/BitgetApi.exe b/BitgetApi/obj/Debug/BitgetApi.exe new file mode 100644 index 0000000..35bb770 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.exe differ diff --git a/BitgetApi/obj/Debug/BitgetApi.pdb b/BitgetApi/obj/Debug/BitgetApi.pdb new file mode 100644 index 0000000..58a30b5 Binary files /dev/null and b/BitgetApi/obj/Debug/BitgetApi.pdb differ diff --git a/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferences.cache new file mode 100644 index 0000000..172f15d Binary files /dev/null and b/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..8831fc7 Binary files /dev/null and b/BitgetApi/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/BitgetApi/obj/Debug/bitgetapi.exe.licenses b/BitgetApi/obj/Debug/bitgetapi.exe.licenses new file mode 100644 index 0000000..9016a2e Binary files /dev/null and b/BitgetApi/obj/Debug/bitgetapi.exe.licenses differ diff --git a/BitgetApi/packages.config b/BitgetApi/packages.config new file mode 100644 index 0000000..6902f3d --- /dev/null +++ b/BitgetApi/packages.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/.signature.p7s b/packages/Microsoft.CSharp.4.7.0/.signature.p7s new file mode 100644 index 0000000..c85e8c2 Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/.signature.p7s differ diff --git a/packages/Microsoft.CSharp.4.7.0/LICENSE.TXT b/packages/Microsoft.CSharp.4.7.0/LICENSE.TXT new file mode 100644 index 0000000..984713a --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/LICENSE.TXT @@ -0,0 +1,23 @@ +The MIT License (MIT) + +Copyright (c) .NET Foundation and Contributors + +All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/Microsoft.CSharp.4.7.0/Microsoft.CSharp.4.7.0.nupkg b/packages/Microsoft.CSharp.4.7.0/Microsoft.CSharp.4.7.0.nupkg new file mode 100644 index 0000000..9e20f68 Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/Microsoft.CSharp.4.7.0.nupkg differ diff --git a/packages/Microsoft.CSharp.4.7.0/THIRD-PARTY-NOTICES.TXT b/packages/Microsoft.CSharp.4.7.0/THIRD-PARTY-NOTICES.TXT new file mode 100644 index 0000000..77a243e --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/THIRD-PARTY-NOTICES.TXT @@ -0,0 +1,375 @@ +.NET Core uses third-party libraries or other resources that may be +distributed under licenses different than the .NET Core software. + +In the event that we accidentally failed to list a required notice, please +bring it to our attention. Post an issue or email us: + + dotnet@microsoft.com + +The attached notices are provided for information only. + +License notice for ASP.NET +------------------------------- + +Copyright (c) .NET Foundation. All rights reserved. +Licensed under the Apache License, Version 2.0. + +Available at +https://github.com/aspnet/AspNetCore/blob/master/LICENSE.txt + +License notice for Slicing-by-8 +------------------------------- + +http://sourceforge.net/projects/slicing-by-8/ + +Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved + + +This software program is licensed subject to the BSD License, available at +http://www.opensource.org/licenses/bsd-license.html. + + +License notice for Unicode data +------------------------------- + +http://www.unicode.org/copyright.html#License + +Copyright © 1991-2017 Unicode, Inc. All rights reserved. +Distributed under the Terms of Use in http://www.unicode.org/copyright.html. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Unicode data files and any associated documentation +(the "Data Files") or Unicode software and any associated documentation +(the "Software") to deal in the Data Files or Software +without restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, and/or sell copies of +the Data Files or Software, and to permit persons to whom the Data Files +or Software are furnished to do so, provided that either +(a) this copyright and permission notice appear with all copies +of the Data Files or Software, or +(b) this copyright and permission notice appear in associated +Documentation. + +THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT OF THIRD PARTY RIGHTS. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS +NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL +DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, +DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THE DATA FILES OR SOFTWARE. + +Except as contained in this notice, the name of a copyright holder +shall not be used in advertising or otherwise to promote the sale, +use or other dealings in these Data Files or Software without prior +written authorization of the copyright holder. + +License notice for Zlib +----------------------- + +https://github.com/madler/zlib +http://zlib.net/zlib_license.html + +/* zlib.h -- interface of the 'zlib' general purpose compression library + version 1.2.11, January 15th, 2017 + + Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + + Jean-loup Gailly Mark Adler + jloup@gzip.org madler@alumni.caltech.edu + +*/ + +License notice for Mono +------------------------------- + +http://www.mono-project.com/docs/about-mono/ + +Copyright (c) .NET Foundation Contributors + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the Software), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +License notice for International Organization for Standardization +----------------------------------------------------------------- + +Portions (C) International Organization for Standardization 1986: + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +License notice for Intel +------------------------ + +"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation +and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +License notice for Xamarin and Novell +------------------------------------- + +Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Copyright (c) 2011 Novell, Inc (http://www.novell.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Third party notice for W3C +-------------------------- + +"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE +Status: This license takes effect 13 May, 2015. +This work is being provided by the copyright holders under the following license. +License +By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions. +Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications: +The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. +Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included. +Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)." +Disclaimers +THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. +COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT. +The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders." + +License notice for Bit Twiddling Hacks +-------------------------------------- + +Bit Twiddling Hacks + +By Sean Eron Anderson +seander@cs.stanford.edu + +Individually, the code snippets here are in the public domain (unless otherwise +noted) — feel free to use them however you please. The aggregate collection and +descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are +distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and +without even the implied warranty of merchantability or fitness for a particular +purpose. + +License notice for Brotli +-------------------------------------- + +Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +compress_fragment.c: +Copyright (c) 2011, Google Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +decode_fuzzer.c: +Copyright (c) 2015 The Chromium Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + +License notice for Json.NET +------------------------------- + +https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md + +The MIT License (MIT) + +Copyright (c) 2007 James Newton-King + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +License notice for vectorized base64 encoding / decoding +-------------------------------------------------------- + +Copyright (c) 2005-2007, Nick Galbreath +Copyright (c) 2013-2017, Alfred Klomp +Copyright (c) 2015-2017, Wojciech Mula +Copyright (c) 2016-2017, Matthieu Darbois +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +- Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS +IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/packages/Microsoft.CSharp.4.7.0/lib/MonoAndroid10/_._ b/packages/Microsoft.CSharp.4.7.0/lib/MonoAndroid10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/MonoTouch10/_._ b/packages/Microsoft.CSharp.4.7.0/lib/MonoTouch10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/net45/_._ b/packages/Microsoft.CSharp.4.7.0/lib/net45/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/netcore50/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/lib/netcore50/Microsoft.CSharp.dll new file mode 100644 index 0000000..bb2848a Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/lib/netcore50/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/lib/netcoreapp2.0/_._ b/packages/Microsoft.CSharp.4.7.0/lib/netcoreapp2.0/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/netstandard1.3/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/lib/netstandard1.3/Microsoft.CSharp.dll new file mode 100644 index 0000000..bb2848a Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/lib/netstandard1.3/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.dll new file mode 100644 index 0000000..bc2cb56 Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.xml new file mode 100644 index 0000000..adf05ce --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/lib/netstandard2.0/Microsoft.CSharp.xml @@ -0,0 +1,200 @@ + + + + Microsoft.CSharp + + + + Contains factory methods to create dynamic call site binders for CSharp. + + + Initializes a new CSharp binary operation binder. + The flags with which to initialize the binder. + The binary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp binary operation binder. + + + Initializes a new CSharp convert binder. + The flags with which to initialize the binder. + The type to convert to. + The that indicates where this operation is used. + A new CSharp convert binder. + + + Initializes a new CSharp get index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp get index binder. + + + Initializes a new CSharp get member binder. + The flags with which to initialize the binder. + The name of the member to get. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp get member binder. + + + Initializes a new CSharp invoke binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke binder. + + + Initializes a new CSharp invoke constructor binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke constructor binder. + + + Initializes a new CSharp invoke member binder. + The flags with which to initialize the binder. + The name of the member to invoke. + The list of type arguments specified for this invoke. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke member binder. + + + Initializes a new CSharp is event binder. + The flags with which to initialize the binder. + The name of the event to look for. + The that indicates where this operation is used. + A new CSharp is event binder. + + + Initializes a new CSharp set index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp set index binder. + + + Initializes a new CSharp set member binder. + The flags with which to initialize the binder. + The name of the member to set. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp set member binder. + + + Initializes a new CSharp unary operation binder. + The flags with which to initialize the binder. + The unary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp unary operation binder. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + Initializes a new instance of the class. + The flags for the argument. + The name of the argument, if named; otherwise null. + A new instance of the class. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The argument is a constant. + + + The argument is passed to an out parameter. + + + The argument is passed to a ref parameter. + + + The argument is a indicating an actual type name used in source. Used only for target objects in static calls. + + + The argument is a named argument. + + + No additional information to represent. + + + The argument's compile-time type should be considered during binding. + + + Represents information about C# dynamic operations that are not specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The binder represents a logical AND or logical OR that is part of a conditional logical operator evaluation. + + + The evaluation of this binder happens in a checked context. + + + The binder represents an implicit conversion for use in an array creation expression. + + + The binder represents an explicit conversion. + + + The binder represents an invoke on a simple name. + + + The binder represents an invoke on a specialname. + + + There is no additional information required for this binder. + + + The binder is used in a position that does not require a result, and can therefore bind to a void returning method. + + + The result of any bind is going to be indexed get a set index or get index binder. + + + The value in this set index or set member comes a compound assignment operator. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class that has serialized data. + The object that holds the serialized object data about the exception being thrown. + The contextual information about the source or destination. + + + Initializes a new instance of the class that has a specified error message. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class with a system-supplied message that describes the error. + + + Initializes a new instance of the class with serialized data. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class with a specified message that describes the error. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/lib/portable-net45+win8+wp8+wpa81/_._ b/packages/Microsoft.CSharp.4.7.0/lib/portable-net45+win8+wp8+wpa81/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/uap10.0.16299/_._ b/packages/Microsoft.CSharp.4.7.0/lib/uap10.0.16299/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/win8/_._ b/packages/Microsoft.CSharp.4.7.0/lib/win8/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/wp80/_._ b/packages/Microsoft.CSharp.4.7.0/lib/wp80/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/wpa81/_._ b/packages/Microsoft.CSharp.4.7.0/lib/wpa81/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/xamarinios10/_._ b/packages/Microsoft.CSharp.4.7.0/lib/xamarinios10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/xamarinmac20/_._ b/packages/Microsoft.CSharp.4.7.0/lib/xamarinmac20/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/xamarintvos10/_._ b/packages/Microsoft.CSharp.4.7.0/lib/xamarintvos10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/lib/xamarinwatchos10/_._ b/packages/Microsoft.CSharp.4.7.0/lib/xamarinwatchos10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/MonoAndroid10/_._ b/packages/Microsoft.CSharp.4.7.0/ref/MonoAndroid10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/MonoTouch10/_._ b/packages/Microsoft.CSharp.4.7.0/ref/MonoTouch10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/net45/_._ b/packages/Microsoft.CSharp.4.7.0/ref/net45/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.dll new file mode 100644 index 0000000..3e2c049 Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.xml new file mode 100644 index 0000000..24b5eba --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contains factory methods to create dynamic call site binders for CSharp. + + + Initializes a new CSharp binary operation binder. + Returns a new CSharp binary operation binder. + The flags with which to initialize the binder. + The binary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp convert binder. + Returns a new CSharp convert binder. + The flags with which to initialize the binder. + The type to convert to. + The that indicates where this operation is used. + + + Initializes a new CSharp get index binder. + Returns a new CSharp get index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp get member binder. + Returns a new CSharp get member binder. + The flags with which to initialize the binder. + The name of the member to get. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke binder. + Returns a new CSharp invoke binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke constructor binder. + Returns a new CSharp invoke constructor binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke member binder. + Returns a new CSharp invoke member binder. + The flags with which to initialize the binder. + The name of the member to invoke. + The list of type arguments specified for this invoke. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp is event binder. + Returns a new CSharp is event binder. + The flags with which to initialize the binder. + The name of the event to look for. + The that indicates where this operation is used. + + + Initializes a new CSharp set index binder. + Returns a new CSharp set index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp set member binder. + Returns a new CSharp set member binder. + The flags with which to initialize the binder. + The name of the member to set. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp unary operation binder. + Returns a new CSharp unary operation binder. + The flags with which to initialize the binder. + The unary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + Initializes a new instance of the class. + A new instance of the class. + The flags for the argument. + The name of the argument, if named; otherwise null. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The argument is a constant. + + + The argument is passed to an out parameter. + + + The argument is passed to a ref parameter. + + + The argument is a indicating an actual type name used in source. Used only for target objects in static calls. + + + The argument is a named argument. + + + No additional information to represent. + + + The argument's compile-time type should be considered during binding. + + + Represents information about C# dynamic operations that are not specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The binder represents a logical AND or logical OR that is part of a conditional logical operator evaluation. + + + The evaluation of this binder happens in a checked context. + + + The binder represents an implicit conversion for use in an array creation expression. + + + The binder represents an explicit conversion. + + + The binder represents an invoke on a simple name. + + + The binder represents an invoke on a specialname. + + + There is no additional information required for this binder. + + + The binder is used in a position that does not require a result, and can therefore bind to a void returning method. + + + The result of any bind is going to be indexed get a set index or get index binder. + + + The value in this set index or set member comes a compound assignment operator. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class that has a specified error message. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class with a system-supplied message that describes the error. + + + Initializes a new instance of the class with a specified message that describes the error. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/de/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/de/Microsoft.CSharp.xml new file mode 100644 index 0000000..5e90c8c --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/de/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Enthält Factorymethoden zum Erstellen dynamischer Aufrufsitebinder für CSharp. + + + Initialisiert einen neuen Binder für binäre CSharp-Vorgänge. + Gibt einen neuen Binder für binäre CSharp-Vorgänge zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Die Art des binären Vorgangs. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Konvertierungsbinder. + Gibt einen neuen CSharp-Konvertierungsbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Typ, in den konvertiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + + + Initialisiert einen neuen Binder zum Abrufen von CSharp-Indizes. + Gibt einen neuen Binder zum Abrufen von CSharp-Indizes zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder zum Abrufen von CSharp-Membern. + Gibt einen neuen Binder zum Abrufen von CSharp-Membern zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des abzurufenden Members. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufbinder. + Gibt einen neuen CSharp-Aufrufbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufkonstruktorbinder. + Gibt einen neuen CSharp-Aufrufkonstruktorbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufmemberbinder. + Gibt einen neuen CSharp-Aufrufmemberbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des aufzurufenden Members. + Die Liste der für diesen Aufruf angegebenen Typargumente. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-ist-Ereignis-Binder. + Gibt einen neuen CSharp-ist-Ereignis-Binder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des zu suchenden Ereignisses. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + + + Initialisiert einen neuen Binder zum Festlegen von CSharp-Indizes. + Gibt einen neuen Binder zum Festlegen von CSharp-Indizes zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder zum Festlegen von CSharp-Membern. + Gibt einen neuen Binder zum Festlegen von CSharp-Membern zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des festzulegenden Members. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder für unäre CSharp-Vorgänge. + Gibt einen neuen Binder für unäre CSharp-Vorgänge zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Die Art des unären Vorgangs. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die für bestimmte Argumente auf einer Aufrufsite spezifisch sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Initialisiert eine neue Instanz der -Klasse. + Eine neue Instanz der -Klasse. + Die Flags für das Argument. + Der Name des Arguments, wenn es sich um ein benanntes Argument handelt, andernfalls NULL. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die für bestimmte Argumente auf einer Aufrufsite spezifisch sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Das Argument ist eine Konstante. + + + Das Argument wird an einen Out-Parameter übergeben. + + + Das Argument wird an einen Ref-Parameter übergeben. + + + Das Argument ist ein , der einen tatsächlichen, in der Quelle verwendeten Typnamen angibt.Wird nur für Zielobjekte in statischen Aufrufen verwendet. + + + Das Argument ist ein benanntes Argument. + + + Es sind keine weitere Informationen vorhanden, die dargestellt werden können. + + + Während der Bindung muss der Kompilierzeittyp des Arguments berücksichtigt werden. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die nicht spezifisch für bestimmte Argumente auf einer Aufrufsite sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Der Binder stellt ein logisches AND oder logisches OR dar, das Teil einer bedingten logischen Operatorauswertung ist. + + + Die Auswertung für diesen Binder erfolgt in einem überprüften Kontext. + + + Der Binder stellt eine implizite Konvertierung für die Verwendung in einem Arrayerstellungsausdruck dar. + + + Der Binder stellt eine explizite Konvertierung dar. + + + Der Binder stellt einen Aufruf für einen einfachen Namen dar. + + + Der Binder stellt einen Aufruf für einen besonderen Namen dar. + + + Für diesen Binder sind keine zusätzlichen Informationen erforderlich. + + + Der Binder wird an einer Position verwendet, an der kein Ergebnis erforderlich ist, und kann daher an eine leere Rückgabemethode binden. + + + Das Ergebnis einer Bindung wird indiziert, es wird ein Binder zum Festlegen oder Abrufen von Indizes abgerufen. + + + Der Wert in diesem festgelegten Index oder festgelegten Member ist ein Verbundzuweisungsoperator. + + + Stellt einen Fehler dar, der auftritt, wenn eine dynamische Bindung im C#-Laufzeitbinder verarbeitet wird. + + + Initialisiert eine neue Instanz der -Klasse. + + + Initialisiert eine neue Instanz der -Klasse, die über eine angegebene Fehlermeldung verfügt. + Die Meldung, in der die Ausnahme beschrieben wirdDer Aufrufer dieses Konstruktors muss sicherstellen, dass diese Zeichenfolge für die aktuelle Systemkultur lokalisiert wurde. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Fehlermeldung und einem Verweis auf die innere Ausnahme, die diese Ausnahme ausgelöst hat. + Die Fehlermeldung, in der die Ursache der Ausnahme erklärt wird. + Die Ausnahme, die die aktuelle Ausnahme ausgelöst hat, oder ein NULL-Verweis, wenn keine innere Ausnahme angegeben ist. + + + Stellt einen Fehler dar, der auftritt, wenn eine dynamische Bindung im C#-Laufzeitbinder verarbeitet wird. + + + Initialisiert eine neue Instanz der -Klasse mit einer vom System bereitgestellten Meldung, die den Fehler beschreibt. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Meldung, die den Fehler beschreibt. + Die Meldung, in der die Ausnahme beschrieben wirdDer Aufrufer dieses Konstruktors muss sicherstellen, dass diese Zeichenfolge für die aktuelle Systemkultur lokalisiert wurde. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Fehlermeldung und einem Verweis auf die innere Ausnahme, die diese Ausnahme ausgelöst hat. + Die Fehlermeldung, in der die Ursache der Ausnahme erklärt wird. + Die Ausnahme, die die aktuelle Ausnahme ausgelöst hat, oder ein NULL-Verweis, wenn keine innere Ausnahme angegeben ist. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/es/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/es/Microsoft.CSharp.xml new file mode 100644 index 0000000..dc76977 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/es/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contiene métodos de generador que permiten crear enlazadores de sitios de llamada dinámicos para CSharp. + + + Inicializa un nuevo enlazador de operaciones binarias de CSharp. + Devuelve un nuevo enlazador de operaciones binarias de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo de operación binaria. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de conversiones de CSharp. + Devuelve un nuevo enlazador de conversiones de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo en el que se va a convertir. + Objeto que indica dónde se usa esta operación. + + + Inicializa un nuevo enlazador de operaciones de obtención de índice de CSharp. + Devuelve un nuevo enlazador de operaciones de obtención de índice de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones de obtención de miembro de CSharp. + Devuelve un nuevo enlazador de operaciones de obtención de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro que se va a obtener. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de CSharp. + Devuelve un nuevo enlazador de invocaciones de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de constructor de CSharp. + Devuelve un nuevo enlazador de invocaciones de constructor de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de miembro de CSharp. + Devuelve un nuevo enlazador de invocaciones de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro al que se va a invocar. + Lista de los argumentos de tipo especificados para esta invocación. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de búsquedas de eventos de CSharp. + Devuelve un nuevo enlazador de búsquedas de eventos de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del evento que se va a buscar. + Objeto que indica dónde se usa esta operación. + + + Inicializa un nuevo enlazador de operaciones de establecimiento de índice de CSharp. + Devuelve un nuevo enlazador de operaciones de establecimiento de índice de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones de establecimiento de miembro de CSharp. + Devuelve un nuevo enlazador de operaciones de establecimiento de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro que se va a establecer. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones unarias de CSharp. + Devuelve un nuevo enlazador de operaciones unarias de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo de operación unaria. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Representa información sobre las operaciones dinámicas de C# que son específicas de argumentos concretos en un lugar de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + Inicializa una nueva instancia de la clase . + Nueva instancia de la clase . + Marcas para el argumento. + Nombre del argumento, si lo tiene; de lo contrario, NULL. + + + Representa información sobre las operaciones dinámicas de C# que son específicas de argumentos concretos en un lugar de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + El argumento es una constante. + + + El argumento se pasa a un parámetro out. + + + El argumento se pasa a un parámetro ref. + + + El argumento es un objeto que indica un nombre de tipo real utilizado en origen.Únicamente se usa para los objetos de destino en las llamadas estáticas. + + + Es un argumento con nombre. + + + Ninguna información adicional para representar. + + + El tipo de tiempo de compilación del argumento debe considerarse durante el enlace. + + + Representa información sobre las operaciones dinámicas de C# que no son específicas de argumentos concretos en un sitio de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + El enlazador representa un operador AND lógico u OR lógico que forma parte de una evaluación de operadores lógicos condicionales. + + + La evaluación de este enlazador se lleva a cabo en un contexto comprobado. + + + El enlazador representa una conversión implícita que se puede usar en una expresión de creación de matrices. + + + El enlazador representa una conversión explícita. + + + El enlazador representa una invocación en un nombre simple. + + + El enlazador representa una invocación en un nombre especial. + + + Este enlazador no requiere ninguna información adicional. + + + El enlazador se usa en una posición que no requiere un resultado y, por lo tanto, se puede enlazar a un método que devuelva void. + + + El resultado de cualquier enlace que se vaya a indizar obtiene un enlazador de índice set o de índice get. + + + El valor de este índice o miembro set se convierte en un operador de asignación compuesto. + + + Representa un error que se produce cuando se procesa un enlace dinámico en el enlazador en tiempo de ejecución de C#. + + + Inicializa una nueva instancia de la clase . + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado. + Mensaje que describe la excepción.El llamador de este constructor debe asegurarse de que esta cadena se ha traducido para la actual referencia cultural del sistema. + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado y una referencia a la excepción interna que representa la causa de esta excepción. + Mensaje de error que explica la razón de la excepción. + Excepción que es la causa de la excepción actual, o una referencia nula si no se especifica ninguna excepción interna. + + + Representa un error que se produce cuando se procesa un enlace dinámico en el enlazador en tiempo de ejecución de C#. + + + Inicializa una nueva instancia de la clase con un mensaje proporcionado por el sistema que describe el error. + + + Inicializa una nueva instancia de la clase con un mensaje de error especificado que describe el error. + Mensaje que describe la excepción.El llamador de este constructor debe asegurarse de que esta cadena se ha traducido para la actual referencia cultural del sistema. + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado y una referencia a la excepción interna que representa la causa de esta excepción. + Mensaje de error que explica la razón de la excepción. + Excepción que es la causa de la excepción actual, o una referencia nula si no se especifica ninguna excepción interna. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/fr/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/fr/Microsoft.CSharp.xml new file mode 100644 index 0000000..6ac8b3b --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/fr/Microsoft.CSharp.xml @@ -0,0 +1,201 @@ + + + + Microsoft.CSharp + + + + Contient des méthodes de fabrique pour créer des classeurs de sites d'appel dynamiques pour CSharp. + + + Initialise un nouveau classeur d'opérations binaires CSharp. + Retourne un nouveau classeur d'opérations binaires CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type d'opération binaire. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de conversion CSharp. + Retourne un nouveau classeur de conversion CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type dans lequel convertir. + + qui indique où cette opération est utilisée. + + + Initialise un nouveau classeur d'obtention d'index CSharp. + Retourne un nouveau classeur d'obtention d'index CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'obtention de membre CSharp. + Retourne un nouveau classeur d'obtention de membre CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à obtenir. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'appel CSharp. + Retourne un nouveau classeur d'appel CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de constructeurs appelés CSharp. + Retourne un nouveau classeur de constructeurs appelés CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de membres appelés CSharp. + Retourne un nouveau classeur de membres appelés CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à appeler. + Liste d'arguments de type spécifiés pour cet appel. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'événements CSharp. + Retourne un nouveau classeur d'événement CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom de l'événement à rechercher. + + qui indique où cette opération est utilisée. + + + Initialise un nouveau classeur de définition d'index CSharp. + Retourne un nouveau classeur de définition d'index CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de définition de membre CSharp. + Retourne un nouveau classeur de définition de membre CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à définir. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'opérations unaires CSharp. + Retourne un nouveau classeur d'opérations unaires CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type d'opération unaire. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Représente les informations relatives aux opérations dynamiques en C# qui sont spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + Initialise une nouvelle instance de la classe . + Nouvelle instance de la classe . + Indicateurs de l'argument. + Nom de l'argument, s'il est nommé ; sinon, null. + + + Représente les informations relatives aux opérations dynamiques en C# qui sont spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + L'argument est une constante. + + + L'argument est passé à un paramètre de sortie (out). + + + L'argument est passé à un paramètre de référence (ref). + + + L'argument est un qui indique un nom de type réel utilisé dans la source.Utilisé uniquement pour les objets cible dans les appels statiques. + + + L'argument est un argument nommé. + + + Aucune information supplémentaire à représenter. + + + Le type de l'argument au moment de la compilation doit être considéré pendant la liaison. + + + Représente les informations relatives aux opérations dynamiques en C# qui ne sont pas spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + Le classeur représente un AND logique ou un OR logique faisant partie d'une évaluation d'opérateur logique conditionnelle. + + + L'évaluation de ce classeur s'effectue dans un contexte vérifié (checked). + + + Le classeur représente une conversion implicite pour une utilisation dans une expression de création de tableau. + + + Le classeur représente une conversion explicite. + + + Le classeur représente un appel sur un nom simple. + + + Le classeur représente un appel sur un nom spécial. + + + Aucune information supplémentaire n'est requise pour ce classeur. + + + Le classeur est utilisé à un emplacement qui ne requiert pas de résultat et peut par conséquent créer une liaison avec une méthode retournant void. + + + Le résultat de n'importe quel lien sera un classeur indexé d'obtention d'index ou de membre défini. + + + La valeur dans cet index défini ou membre défini provient d'un opérateur d'assignation composée. + + + Représente une erreur qui se produit lorsqu'un lien dynamique dans le binder d'exécution C# est traité. + + + Initialise une nouvelle instance de la classe . + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié. + Message qui décrit l'exception.L'appelant de ce constructeur doit vérifier que cette chaîne a été localisée pour la culture du système en cours. + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié et une référence à l'exception interne à l'origine de cette exception. + Message d'erreur indiquant la raison de l'exception. + Exception à l'origine de l'exception actuelle, ou référence null si aucune exception interne n'est spécifiée. + + + Représente une erreur qui se produit lorsqu'un lien dynamique dans le binder d'exécution C# est traité. + + + Initialise une nouvelle instance de la classe avec un message système décrivant l'erreur. + + + Initialise une nouvelle instance de la classe avec un message spécifié décrivant l'erreur. + Message qui décrit l'exception.L'appelant de ce constructeur doit vérifier que cette chaîne a été localisée pour la culture du système en cours. + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié et une référence à l'exception interne à l'origine de cette exception. + Message d'erreur indiquant la raison de l'exception. + Exception à l'origine de l'exception actuelle, ou référence null si aucune exception interne n'est spécifiée. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/it/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/it/Microsoft.CSharp.xml new file mode 100644 index 0000000..e7621f3 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/it/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contiene metodi factory per creare gestori di associazione del sito di chiamata dinamica per CSharp. + + + Inizializza un nuovo gestore di associazione dell'operazione binaria di CSharp. + Restituisce un nuovo gestore di associazione dell'operazione binaria di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo di operazione binaria. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione delle conversioni di CSharp. + Restituisce un nuovo gestore di associazione delle conversioni di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo in cui eseguire la conversione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + + + Inizializza un nuovo gestore di associazione dell'indice get di CSharp. + Restituisce un nuovo gestore di associazione dell'indice get di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro get di CSharp. + Restituisce un nuovo gestore di associazione del membro get di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da ottenere. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione invoke di CSharp. + Restituisce un nuovo gestore di associazione invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del costruttore invoke di CSharp. + Restituisce un nuovo gestore di associazione del costruttore invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro invoke di CSharp. + Restituisce un nuovo gestore di associazione del membro invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da richiamare, + Elenco di argomenti del tipo specificati per la chiamata. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione degli eventi is di CSharp. + Restituisce un nuovo gestore di associazione degli eventi is di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome dell'evento di cui eseguire la ricerca. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + + + Inizializza un nuovo gestore di associazione dell'indice set di CSharp. + Restituisce un nuovo gestore di associazione dell'indice set di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro set di CSharp. + Restituisce un nuovo gestore di associazione del membro set di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da impostare. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione dell'operazione unaria di CSharp. + Restituisce un nuovo gestore di associazione dell'operazione unaria di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo di operazione unaria. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Rappresenta informazioni sulle operazioni dinamiche in C# specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + Inizializza una nuova istanza della classe . + Nuova istanza della classe . + Flag per l'argomento. + Nome dell'argomento, se denominato; in caso contrario, null. + + + Rappresenta informazioni sulle operazioni dinamiche in C# specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + L'argomento è una costante. + + + L'argomento viene passato a un parametro out. + + + L'argomento viene passato a un parametro ref. + + + L'argomento è un oggetto che indica un nome di tipo effettivo utilizzato nell'origine.Utilizzato solo per gli oggetti di destinazione in chiamate statiche. + + + L'argomento è un argomento denominato. + + + Nessuna informazione aggiuntiva da rappresentare. + + + Il tipo dell'argomento in fase di compilazione deve essere considerato durante l'associazione. + + + Rappresenta informazioni sulle operazioni dinamiche in C# non specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + Il gestore di associazione rappresenta un operatore logico AND o OR che fa parte di una valutazione dell'operatore logico condizionale. + + + La valutazione di questo gestore di associazione si verifica in un contesto verificato. + + + Il gestore di associazione rappresenta una conversione implicita per l'utilizzo in un'espressione di creazione di una matrice. + + + Il gestore di associazione rappresenta una conversione esplicita. + + + Il gestore di associazione rappresenta una chiamata per un nome semplice. + + + Il gestore di associazione rappresenta una chiamata per uno SpecialName. + + + Non sono presenti informazioni aggiuntive necessarie per questo gestore di associazione. + + + Il gestore di associazione viene utilizzato in una posizione che non richiede un risultato e può quindi essere associato a un metodo che restituisce void. + + + Il risultato di qualsiasi associazione sarà indicizzato per ottenere un gestore di associazione dell'indice set o get. + + + Il valore in questo indice set o membro set presenta un operatore di assegnazione composto. + + + Rappresenta un errore che si verifica quando viene elaborata un'associazione dinamica nel gestore di associazione di runtime in C#. + + + Inizializza una nuova istanza della classe . + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato. + Messaggio in cui viene descritta l'eccezione.È necessario che il chiamante del costruttore assicuri che la stringa sia stata localizzata per le impostazioni cultura correnti del sistema. + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato e un riferimento all'eccezione interna che ha generato l'eccezione. + Messaggio di errore nel quale viene indicato il motivo dell’eccezione + Eccezione che ha provocato l'eccezione corrente o riferimento null se non è stata specificata alcuna eccezione interna. + + + Rappresenta un errore che si verifica quando viene elaborata un'associazione dinamica nel gestore di associazione di runtime in C#. + + + Inizializza una nuova istanza della classe con un messaggio fornito dal sistema in cui viene descritto l'errore. + + + Inizializza una nuova istanza della classe con un messaggio specifico in cui viene descritto l'errore. + Messaggio in cui viene descritta l'eccezione.È necessario che il chiamante del costruttore assicuri che la stringa sia stata localizzata per le impostazioni cultura correnti del sistema. + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato e un riferimento all'eccezione interna che ha generato l'eccezione. + Messaggio di errore nel quale viene indicato il motivo dell’eccezione + Eccezione che ha provocato l'eccezione corrente o riferimento null se non è stata specificata alcuna eccezione interna. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ja/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ja/Microsoft.CSharp.xml new file mode 100644 index 0000000..e1f883c --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ja/Microsoft.CSharp.xml @@ -0,0 +1,193 @@ + + + + Microsoft.CSharp + + + + CSharp の動的呼び出しサイト バインダーを作成するファクトリ メソッドが含まれています。 + + + CSharp の新しい二項演算バインダーを初期化します。 + CSharp の新しい二項演算バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 二項演算の種類。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい変換バインダーを初期化します。 + CSharp の新しい変換バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 変換後の型。 + この操作の使用場所を示す 。 + + + CSharp の新しいインデックス取得バインダーを初期化します。 + CSharp の新しいインデックス取得バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー取得バインダーを初期化します。 + CSharp の新しいメンバー取得バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 取得するメンバーの名前。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい呼び出しバインダーを初期化します。 + CSharp の新しい呼び出しバインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいコンストラクター バインダーを初期化します。 + CSharp の新しいコンストラクター バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー呼び出しバインダーを初期化します。 + CSharp の新しいメンバー呼び出しバインダーを返します。 + バインダーの初期化に使用するフラグ。 + 呼び出されるメンバーの名前。 + この呼び出しに対して指定する型引数のリスト。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいイベント確認バインダーを初期化します。 + CSharp の新しいイベント確認バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 検索するイベントの名前。 + この操作の使用場所を示す 。 + + + CSharp の新しいインデックス設定バインダーを初期化します。 + CSharp の新しいインデックス設定バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー設定バインダーを初期化します。 + CSharp の新しいメンバー設定バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 設定するメンバーの名前。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい単項演算バインダーを初期化します。 + CSharp の新しい単項演算バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 単項演算の種類。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + 呼び出しサイトにおける特定の引数に固有の、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + + クラスの新しいインスタンスを初期化します。 + + クラスの新しいインスタンス。 + 引数のフラグ。 + 引数に名前がある場合はその名前。それ以外の場合は null。 + + + 呼び出しサイトにおける特定の引数に固有の、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + 引数は定数です。 + + + 引数は out パラメーターに渡されます。 + + + 引数は ref パラメーターに渡されます。 + + + 引数は、ソースで使用されている実際の型名を示す です。静的呼び出しのターゲット オブジェクトでのみ使用されます。 + + + 引数は名前付き引数です。 + + + 追加情報はありません。 + + + 引数のコンパイル時の型はバインディング時に考慮されます。 + + + 呼び出しサイトにおける特定の引数に固有ではない、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + このバインダーは、条件論理演算子の評価の一部である論理 AND または論理 OR を表します。 + + + このバインダーの評価は、checked コンテキストで行われます。 + + + このバインダーは、配列作成式で使用する暗黙の型変換を表します。 + + + このバインダーは、明示的な変換を表します。 + + + このバインダーは、簡易名での呼び出しを表します。 + + + このバインダーは、特別な名前での呼び出しを表します。 + + + このバインダーに必要な追加情報はありません。 + + + バインダーは、結果を必要としない位置で使用されるため、戻り型が void のメソッドにバインドできます。 + + + どのバインドの結果にもインデックスが付けられます。インデックス設定バインダーまたはインデックス取得バインダーが必要です。 + + + このインデックス設定またはメンバー設定の値は複合代入演算子になります。 + + + C# ランタイム バインダーで動的バインドが処理されたときに発生するエラーを表します。 + + + + クラスの新しいインスタンスを初期化します。 + + + 指定したエラー メッセージを持つ、 クラスの新しいインスタンスを初期化します。 + 例外を説明するメッセージ。このコンストラクターの呼び出し元では、この文字列が現在のシステムのカルチャに合わせてローカライズ済みであることを確認しておく必要があります。 + + + 指定したエラー メッセージおよびこの例外の原因である内部例外への参照を持つ、 クラスの新しいインスタンスを初期化します。 + 例外の原因を説明するエラー メッセージ。 + 現在の例外の原因となった例外。内部例外が指定されていない場合は null 参照。 + + + C# ランタイム バインダーで動的バインドが処理されたときに発生するエラーを表します。 + + + エラーを説明するシステム提供のメッセージを使用して、 クラスの新しいインスタンスを初期化します。 + + + エラーを説明する指定したメッセージを使用して、 クラスの新しいインスタンスを初期化します。 + 例外を説明するメッセージ。このコンストラクターの呼び出し元では、この文字列が現在のシステムのカルチャに合わせてローカライズ済みであることを確認しておく必要があります。 + + + 指定したエラー メッセージおよびこの例外の原因である内部例外への参照を持つ、 クラスの新しいインスタンスを初期化します。 + 例外の原因を説明するエラー メッセージ。 + 現在の例外の原因となった例外。内部例外が指定されていない場合は null 参照。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ko/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ko/Microsoft.CSharp.xml new file mode 100644 index 0000000..2e64855 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ko/Microsoft.CSharp.xml @@ -0,0 +1,193 @@ + + + + Microsoft.CSharp + + + + CSharp의 동적 호출 사이트 바인더를 만드는 팩터리 메서드가 들어 있습니다. + + + 새 CSharp 이항 연산 바인더를 초기화합니다. + 새 CSharp 이항 연산 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이항 연산 종류입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 변환 바인더를 초기화합니다. + 새 CSharp 변환 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 변환할 대상 형식입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + + + 새 CSharp 인덱스 가져오기 바인더를 초기화합니다. + 새 CSharp 인덱스 가져오기 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 가져오기 바인더를 초기화합니다. + 새 CSharp 멤버 가져오기 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 가져올 멤버의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 호출 바인더를 초기화합니다. + 새 CSharp 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 생성자 호출 바인더를 초기화합니다. + 새 CSharp 생성자 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 호출 바인더를 초기화합니다. + 새 CSharp 멤버 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 호출할 멤버의 이름입니다. + 이 호출에 대해 지정된 형식 인수의 목록입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 이벤트 확인 바인더를 초기화합니다. + 새 CSharp 이벤트 확인 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 찾을 이벤트의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + + + 새 CSharp 인덱스 설정 바인더를 초기화합니다. + 새 CSharp 인덱스 설정 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 설정 바인더를 초기화합니다. + 새 CSharp 멤버 설정 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 설정할 멤버의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 단항 연산 바인더를 초기화합니다. + 새 CSharp 단항 연산 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 단항 연산 종류입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 호출 사이트의 특정 인수와 관련된 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + + 클래스의 새 인스턴스를 초기화합니다. + + 클래스의 새 인스턴스입니다. + 인수의 플래그입니다. + 명명된 경우 인수의 이름이고, 그렇지 않으면 null입니다. + + + 호출 사이트의 특정 인수와 관련된 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + 인수가 상수입니다. + + + 인수가 out 매개 변수에 전달됩니다. + + + 인수가 ref 매개 변수에 전달됩니다. + + + 인수가 소스에서 사용된 실제 형식 이름을 나타내는 입니다.정적 호출의 대상 개체에만 사용됩니다. + + + 인수가 명명된 인수입니다. + + + 나타낼 추가 정보가 없습니다. + + + 바인딩하는 동안 인수의 컴파일 타임 형식을 고려해야 합니다. + + + 호출 사이트의 특정 인수와 관련되지 않은 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + 바인더는 조건부 논리 연산자 계산에 속하는 논리적 AND 또는 논리적 OR를 나타냅니다. + + + 이 바인더에 대한 계산은 확인된 컨텍스트에서 발생합니다. + + + 바인더는 배열 생성 식에 사용할 암시적 변환을 나타냅니다. + + + 바인더는 명시적 변환을 나타냅니다. + + + 바인더는 단순한 이름에 대한 호출을 나타냅니다. + + + 바인더는 특수한 이름에 대한 호출을 나타냅니다. + + + 이 바인더에 필요한 추가 정보가 없습니다. + + + 바인더는 결과가 필요 없는 위치에서 사용되므로 void를 반환하는 메서드에 바인딩할 수 있습니다. + + + 바인딩의 결과가 인덱싱되어 인덱스 설정 또는 인덱스 가져오기 바인더를 가져옵니다. + + + 이 인덱스 설정 또는 멤버 설정의 값은 복합 할당 연산자에서 사용됩니다. + + + C# 런타임 바인더의 동적 바인드가 처리될 때 발생하는 오류를 나타냅니다. + + + + 클래스의 새 인스턴스를 초기화합니다. + + + 지정된 오류 메시지가 있는 클래스의 새 인스턴스를 초기화합니다. + 예외를 설명하는 메시지입니다.이 생성자의 호출자는 이 문자열이 현재 시스템 문화권에 맞게 지역화되었는지 확인하는 데 필요합니다. + + + 지정된 오류 메시지 및 해당 예외의 원인인 내부 예외에 대한 참조가 있는 클래스의 새 인스턴스를 초기화합니다. + 예외에 대한 이유를 설명하는 오류 메시지입니다. + 현재 예외의 원인인 예외 또는 내부 예외가 지정되지 않은 경우 null 참조입니다. + + + C# 런타임 바인더의 동적 바인드가 처리될 때 발생하는 오류를 나타냅니다. + + + 오류를 설명하는 시스템 제공 메시지를 사용하여 클래스의 새 인스턴스를 초기화합니다. + + + 오류를 설명하는 지정된 메시지를 사용하여 클래스의 새 인스턴스를 초기화합니다. + 예외를 설명하는 메시지입니다.이 생성자의 호출자는 이 문자열이 현재 시스템 문화권에 맞게 지역화되었는지 확인하는 데 필요합니다. + + + 지정된 오류 메시지와 이 예외의 원인인 내부 예외에 대한 참조를 갖는 클래스의 새 인스턴스를 초기화합니다. + 예외에 대한 이유를 설명하는 오류 메시지입니다. + 현재 예외의 원인인 예외 또는 내부 예외가 지정되지 않은 경우 null 참조입니다. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ru/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ru/Microsoft.CSharp.xml new file mode 100644 index 0000000..de8cf29 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/ru/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Содержит фабричные методы для создания динамических связывателей источников вызова для CSharp. + + + Инициализирует новый связыватель бинарной операции CSharp. + Возвращает новый связыватель бинарной операции CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Вид бинарной операции. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель преобразования CSharp. + Возвращает новый связыватель преобразования CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Тип, в который выполняется преобразование. + Объект , который указывает, где используется операция. + + + Инициализирует новый связыватель получения индекса CSharp. + Возвращает новый связыватель получения индекса CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель получения члена CSharp. + Возвращает новый связыватель получения члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя возвращаемого члена. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова CSharp. + Возвращает новый связыватель вызова CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова конструктора CSharp. + Возвращает новый связыватель вызова конструктора CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова члена CSharp. + Возвращает новый связыватель вызова члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя элемента, который предполагается вызвать. + Список аргументов типа, указанных для данного вызова. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель поиска события CSharp. + Возвращает новый связыватель поиска события CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя искомого события. + Объект , который указывает, где используется операция. + + + Инициализирует новый связыватель задания индекса CSharp. + Возвращает новый связыватель задания индекса CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель задания члена CSharp. + Возвращает новый связыватель задания члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя задаваемого члена. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель унарной операции CSharp. + Возвращает новый связыватель унарной операции CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Вид унарной операции. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Представляет сведения о динамических операциях C#, которые относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Инициализирует новый экземпляр класса . + Новый экземпляр класса . + Флаги для аргумента. + Имя аргумента, если ему присвоено имя, или NULL в противном случае. + + + Представляет сведения о динамических операциях C#, которые относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Аргумент является константой. + + + Аргумент, передаваемый в параметр out. + + + Аргумент, передаваемый в параметр ref. + + + Аргумент является объектом типа , указывающим фактическое имя типа, используемое в источнике.Используется только для целевых объектов в статических вызовах. + + + Аргумент является именованным аргументом. + + + Дополнительные сведения не представлены. + + + В процессе привязки следует учитывать тип времени компиляции аргумента. + + + Представляет сведения о динамических операциях C#, которые не относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Связыватель представляет логическое И или логическое ИЛИ, которое является частью оценки условного логического оператора. + + + Оценка данного связывателя происходит в проверяемом контексте. + + + Связыватель представляет неявное преобразование для использовании в выражении, создающем массив. + + + Связыватель представляет явное преобразование. + + + Связыватель представляет вызов по простому имени. + + + Связыватель представляет вызов по специальному имени. + + + Для данного связывателя не требуются дополнительные сведения. + + + Этот связыватель используется в позиции, не требующей результата, и, следовательно, может выполнять привязку к методу, возвращающему значение void. + + + Результатом любой привязки будет индексированный метод получения связывателя задания или получения индекса. + + + Значение данного метода задания индекса или члена становится частью составного оператора присваивания. + + + Представляет ошибку, которая происходит при обработке динамической привязки в связывателе среды выполнения C#. + + + Инициализирует новый экземпляр класса . + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке. + Сообщение с описанием исключения.Вызывающий оператор этого конструктора необходим, чтобы убедиться, локализована ли данная строка для текущего языка и региональных параметров системы. + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке и ссылку на внутреннее исключение, которое стало причиной данного исключения. + Сообщение об ошибке с объяснением причин исключения. + Исключение, вызвавшее текущее исключение, или пустая ссылка, если внутреннее исключение не задано. + + + Представляет ошибку, которая происходит при обработке динамической привязки в связывателе среды выполнения C#. + + + Инициализирует новый экземпляр класса системным сообщением, содержащим описание ошибки. + + + Инициализирует новый экземпляр класса заданным сообщением, содержащим описание ошибки. + Сообщение с описанием исключения.Вызывающий оператор этого конструктора необходим, чтобы убедиться, локализована ли данная строка для текущего языка и региональных параметров системы. + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке и ссылку на внутреннее исключение, которое стало причиной данного исключения. + Сообщение об ошибке с объяснением причин исключения. + Исключение, вызвавшее текущее исключение, или пустая ссылка, если внутреннее исключение не задано. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hans/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hans/Microsoft.CSharp.xml new file mode 100644 index 0000000..3b0aa98 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hans/Microsoft.CSharp.xml @@ -0,0 +1,191 @@ + + + + Microsoft.CSharp + + + + 包含用于为 CSharp 创建动态调用站点联编程序的工厂方法。 + + + 初始化新的 CSharp 二元运算联编程序。 + 返回新的 CSharp 二元运算联编程序。 + 用于初始化联编程序的标志。 + 二元运算类型。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 转换联编程序。 + 返回新的 CSharp 转换联编程序。 + 用于初始化联编程序的标志。 + 要转换到的类型。 + 用于指示此操作的使用位置的 。 + + + 初始化新的 CSharp 获取索引联编程序。 + 返回新的 CSharp 获取索引联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 获取成员联编程序。 + 返回新的 CSharp 获取成员联编程序。 + 用于初始化联编程序的标志。 + 要获取的成员名称。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用联编程序。 + 返回新的 CSharp 调用联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用构造函数联编程序。 + 返回新的 CSharp 调用构造函数联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用成员联编程序。 + 返回新的 CSharp 调用成员联编程序。 + 用于初始化联编程序的标志。 + 要调用的成员名。 + 为此调用指定的类型参数的列表。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 事件联编程序。 + 返回新的 CSharp 事件联编程序。 + 用于初始化联编程序的标志。 + 要查找的事件的名称。 + 用于指示此操作的使用位置的 。 + + + 初始化新的 CSharp 设置索引联编程序。 + 返回新的 CSharp 设置索引联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 设置成员联编程序。 + 返回新的 CSharp 设置成员联编程序。 + 用于初始化联编程序的标志。 + 要设置的成员的名称。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 一元运算联编程序。 + 返回新的 CSharp 一元运算联编程序。 + 用于初始化联编程序的标志。 + 一元运算类型。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 表示有关特定于调用站点上的特定参数的 C# 动态操作的信息。此类的实例由 C# 编译器生成。 + + + 初始化 类的新实例。 + + 类的新实例。 + 参数的标志。 + 如果已指定参数名称，则为相应的名称；否则为空。 + + + 表示有关特定于调用站点上的特定参数的 C# 动态操作的信息。此类的实例由 C# 编译器生成。 + + + 该参数是一个常量。 + + + 将实参传递到 out 形参。 + + + 将实参传递到 ref 形参。 + + + 参数为 ，它指示源中使用的实际类型名称。仅用于静态调用中的目标对象。 + + + 参数为命名参数。 + + + 没有要表示的附加信息。 + + + 在绑定期间，应考虑参数的编译时类型。 + + + 表示不特定于调用站点上特定参数的 C# 动态操作的相关信息。此类的实例由 C# 编译器生成。 + + + 此联编程序表示作为条件逻辑运算符计算的一部分的逻辑 AND 或逻辑 OR。 + + + 在已检查的上下文中计算此联编程序。 + + + 此联编程序表示要在数组创建表达式中使用的隐式转换。 + + + 此联编程序表示显式转换。 + + + 此联编程序表示对简单名称的调用。 + + + 此联编程序表示对特殊名称的调用。 + + + 此联编程序不需要附加信息。 + + + 联编程序在不需要结果的位置中使用，因此可绑定到一个 void 返回方法。 + + + 将为任何绑定的结果编制索引，以获得一个设置索引联编程序或获取索引联编程序。 + + + 此设置索引或设置成员中的值为复合赋值运算符。 + + + 表示在处理 C# 运行时联编程序中的动态绑定时发生的错误。 + + + 初始化 类的新实例。 + + + 初始化 类的新实例，它包含指定的错误消息。 + 描述该异常的消息。此构造函数的调用方需要确保此字符串已针对当前系统区域性进行了本地化。 + + + 初始化 类的新实例，该实例具有指定的错误消息以及对导致此异常的内部异常的引用。 + 解释异常原因的错误信息。 + 导致当前异常的异常；如果未指定内部异常，则为空引用。 + + + 表示在处理 C# 运行时联编程序中的动态绑定时发生的错误。 + + + 使用由系统提供的用来描述错误的消息初始化 类的新实例。 + + + 使用指定的描述错误的消息初始化 类的新实例。 + 描述该异常的消息。此构造函数的调用方需要确保此字符串已针对当前系统区域性进行了本地化。 + + + 初始化 类的新实例，该实例具有指定的错误消息以及对导致此异常的内部异常的引用。 + 解释异常原因的错误信息。 + 导致当前异常的异常；如果未指定内部异常，则为空引用。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hant/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hant/Microsoft.CSharp.xml new file mode 100644 index 0000000..043924f --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netcore50/zh-hant/Microsoft.CSharp.xml @@ -0,0 +1,211 @@ + + + + Microsoft.CSharp + + + + 包含建立 CSharp 動態呼叫位置繫結器的 Factory 方法。 + + + 初始化新的 CSharp 二進位運算繫結器。 + 傳回新的 CSharp 二進位運算繫結器。 + 用來初始化繫結器的旗標。 + 二元運算類型。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 轉換繫結器。 + 傳回新的 CSharp 轉換繫結器。 + 用來初始化繫結器的旗標。 + 要轉換成的型別。 + + ，指定在何處使用此作業。 + + + 初始化新的 CSharp get 索引繫結器。 + 傳回新的 CSharp get 索引繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp get 成員繫結器。 + 傳回新的 CSharp get 成員繫結器。 + 用來初始化繫結器的旗標。 + 要取得的成員名稱。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用繫結器。 + 傳回新的 CSharp 叫用繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用建構函式繫結器。 + 傳回新的 CSharp 叫用建構函式繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用成員繫結器。 + 傳回新的 CSharp 叫用成員繫結器。 + 用來初始化繫結器的旗標。 + 要叫用的成員名稱。 + 為此叫用指定之型別引數的清單。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp Is 事件繫結器。 + 傳回新的 CSharp Is 事件繫結器。 + 用來初始化繫結器的旗標。 + 要尋找之事件的名稱。 + + ，指定在何處使用此作業。 + + + 初始化新的 CSharp set 索引繫結器。 + 傳回新的 CSharp set 索引繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp set 成員繫結器。 + 傳回新的 CSharp set 成員繫結器。 + 用來初始化繫結器的旗標。 + 要設定之成員的名稱。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 一元運算繫結器。 + 傳回新的 CSharp 一元運算繫結器。 + 用來初始化繫結器的旗標。 + 一元運算類型。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 表示呼叫位置上特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 初始化 類別的新執行個體。 + + 類別的新執行個體。 + 引數的旗標。 + 如果是具名引數，則為引數的名稱，否則為 null。 + + + 表示呼叫位置上特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 引數為常數。 + + + 引數傳遞給 out 參數。 + + + 引數傳遞給 ref 參數。 + + + 引數為 ，表示來源中使用的實際型別名稱。只用於靜態呼叫中的目標物件。 + + + 引數為具名引數。 + + + 無其他要表示的資訊。 + + + 繫結期間應該考慮引數的編譯時期型別。 + + + 表示呼叫位置上非特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 繫結器表示邏輯 AND 或邏輯 OR，這些是條件邏輯運算子評估的一部分。 + + + 此繫結器的評估會在檢查的內容中進行。 + + + 繫結器表示陣列建立運算式中使用的隱含轉換。 + + + 繫結器表示明確轉換。 + + + 繫結器表示在簡單名稱上叫用。 + + + 繫結器表示在 Specialname 上叫用。 + + + 此繫結器不需要額外的資訊。 + + + 繫結器用於不需要結果的位置，因此可以繫結至傳回 Void 的方法。 + + + 任何繫結的結果都會變成索引的 get 索引或 set 索引，或 get 索引繫結器。 + + + 此 set 索引或 set 成員中的值為複合指派運算子。 + + + 表示在處理 C# 執行階段繫結器中的動態繫結時所發生的錯誤。 + + + 初始化 類別的新執行個體。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息。 + 說明例外狀況的訊息。這個建構函式的呼叫端必須確保這個字串已經為目前系統的文化特性當地語系化。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息和造成這個例外狀況發生之內部例外狀況的參考。 + 解釋例外狀況原因的錯誤訊息。 + 導致目前例外狀況發生的例外狀況，如果沒有指定內部例外狀況則為 null 參考。 + + + 表示在處理 C# 執行階段繫結器中的動態繫結時所發生的錯誤。 + + + 以系統提供的錯誤說明訊息，初始化 類別的新執行個體。 + + + 使用指定的錯誤說明訊息，初始化 類別的新執行個體。 + 說明例外狀況的訊息。這個建構函式的呼叫端必須確保這個字串已經為目前系統的文化特性當地語系化。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息和造成這個例外狀況發生之內部例外狀況的參考。 + 解釋例外狀況原因的錯誤訊息。 + 導致目前例外狀況發生的例外狀況，如果沒有指定內部例外狀況則為 null 參考。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netcoreapp2.0/_._ b/packages/Microsoft.CSharp.4.7.0/ref/netcoreapp2.0/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.dll new file mode 100644 index 0000000..3e2c049 Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.xml new file mode 100644 index 0000000..24b5eba --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contains factory methods to create dynamic call site binders for CSharp. + + + Initializes a new CSharp binary operation binder. + Returns a new CSharp binary operation binder. + The flags with which to initialize the binder. + The binary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp convert binder. + Returns a new CSharp convert binder. + The flags with which to initialize the binder. + The type to convert to. + The that indicates where this operation is used. + + + Initializes a new CSharp get index binder. + Returns a new CSharp get index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp get member binder. + Returns a new CSharp get member binder. + The flags with which to initialize the binder. + The name of the member to get. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke binder. + Returns a new CSharp invoke binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke constructor binder. + Returns a new CSharp invoke constructor binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp invoke member binder. + Returns a new CSharp invoke member binder. + The flags with which to initialize the binder. + The name of the member to invoke. + The list of type arguments specified for this invoke. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp is event binder. + Returns a new CSharp is event binder. + The flags with which to initialize the binder. + The name of the event to look for. + The that indicates where this operation is used. + + + Initializes a new CSharp set index binder. + Returns a new CSharp set index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp set member binder. + Returns a new CSharp set member binder. + The flags with which to initialize the binder. + The name of the member to set. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Initializes a new CSharp unary operation binder. + Returns a new CSharp unary operation binder. + The flags with which to initialize the binder. + The unary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + Initializes a new instance of the class. + A new instance of the class. + The flags for the argument. + The name of the argument, if named; otherwise null. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The argument is a constant. + + + The argument is passed to an out parameter. + + + The argument is passed to a ref parameter. + + + The argument is a indicating an actual type name used in source. Used only for target objects in static calls. + + + The argument is a named argument. + + + No additional information to represent. + + + The argument's compile-time type should be considered during binding. + + + Represents information about C# dynamic operations that are not specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The binder represents a logical AND or logical OR that is part of a conditional logical operator evaluation. + + + The evaluation of this binder happens in a checked context. + + + The binder represents an implicit conversion for use in an array creation expression. + + + The binder represents an explicit conversion. + + + The binder represents an invoke on a simple name. + + + The binder represents an invoke on a specialname. + + + There is no additional information required for this binder. + + + The binder is used in a position that does not require a result, and can therefore bind to a void returning method. + + + The result of any bind is going to be indexed get a set index or get index binder. + + + The value in this set index or set member comes a compound assignment operator. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class that has a specified error message. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class with a system-supplied message that describes the error. + + + Initializes a new instance of the class with a specified message that describes the error. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/de/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/de/Microsoft.CSharp.xml new file mode 100644 index 0000000..5e90c8c --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/de/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Enthält Factorymethoden zum Erstellen dynamischer Aufrufsitebinder für CSharp. + + + Initialisiert einen neuen Binder für binäre CSharp-Vorgänge. + Gibt einen neuen Binder für binäre CSharp-Vorgänge zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Die Art des binären Vorgangs. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Konvertierungsbinder. + Gibt einen neuen CSharp-Konvertierungsbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Typ, in den konvertiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + + + Initialisiert einen neuen Binder zum Abrufen von CSharp-Indizes. + Gibt einen neuen Binder zum Abrufen von CSharp-Indizes zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder zum Abrufen von CSharp-Membern. + Gibt einen neuen Binder zum Abrufen von CSharp-Membern zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des abzurufenden Members. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufbinder. + Gibt einen neuen CSharp-Aufrufbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufkonstruktorbinder. + Gibt einen neuen CSharp-Aufrufkonstruktorbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-Aufrufmemberbinder. + Gibt einen neuen CSharp-Aufrufmemberbinder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des aufzurufenden Members. + Die Liste der für diesen Aufruf angegebenen Typargumente. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen CSharp-ist-Ereignis-Binder. + Gibt einen neuen CSharp-ist-Ereignis-Binder zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des zu suchenden Ereignisses. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + + + Initialisiert einen neuen Binder zum Festlegen von CSharp-Indizes. + Gibt einen neuen Binder zum Festlegen von CSharp-Indizes zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder zum Festlegen von CSharp-Membern. + Gibt einen neuen Binder zum Festlegen von CSharp-Membern zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Der Name des festzulegenden Members. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Initialisiert einen neuen Binder für unäre CSharp-Vorgänge. + Gibt einen neuen Binder für unäre CSharp-Vorgänge zurück. + Die Flags, mit denen der Binder initialisiert werden soll. + Die Art des unären Vorgangs. + Der , der angibt, an welcher Position dieser Vorgang verwendet wird. + Die Sequenz von -Instanzen für die Argumente dieses Vorgangs. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die für bestimmte Argumente auf einer Aufrufsite spezifisch sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Initialisiert eine neue Instanz der -Klasse. + Eine neue Instanz der -Klasse. + Die Flags für das Argument. + Der Name des Arguments, wenn es sich um ein benanntes Argument handelt, andernfalls NULL. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die für bestimmte Argumente auf einer Aufrufsite spezifisch sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Das Argument ist eine Konstante. + + + Das Argument wird an einen Out-Parameter übergeben. + + + Das Argument wird an einen Ref-Parameter übergeben. + + + Das Argument ist ein , der einen tatsächlichen, in der Quelle verwendeten Typnamen angibt.Wird nur für Zielobjekte in statischen Aufrufen verwendet. + + + Das Argument ist ein benanntes Argument. + + + Es sind keine weitere Informationen vorhanden, die dargestellt werden können. + + + Während der Bindung muss der Kompilierzeittyp des Arguments berücksichtigt werden. + + + Stellt Informationen zu dynamischen C#-Vorgängen dar, die nicht spezifisch für bestimmte Argumente auf einer Aufrufsite sind.Instanzen dieser Klasse werden vom C#-Compiler generiert. + + + Der Binder stellt ein logisches AND oder logisches OR dar, das Teil einer bedingten logischen Operatorauswertung ist. + + + Die Auswertung für diesen Binder erfolgt in einem überprüften Kontext. + + + Der Binder stellt eine implizite Konvertierung für die Verwendung in einem Arrayerstellungsausdruck dar. + + + Der Binder stellt eine explizite Konvertierung dar. + + + Der Binder stellt einen Aufruf für einen einfachen Namen dar. + + + Der Binder stellt einen Aufruf für einen besonderen Namen dar. + + + Für diesen Binder sind keine zusätzlichen Informationen erforderlich. + + + Der Binder wird an einer Position verwendet, an der kein Ergebnis erforderlich ist, und kann daher an eine leere Rückgabemethode binden. + + + Das Ergebnis einer Bindung wird indiziert, es wird ein Binder zum Festlegen oder Abrufen von Indizes abgerufen. + + + Der Wert in diesem festgelegten Index oder festgelegten Member ist ein Verbundzuweisungsoperator. + + + Stellt einen Fehler dar, der auftritt, wenn eine dynamische Bindung im C#-Laufzeitbinder verarbeitet wird. + + + Initialisiert eine neue Instanz der -Klasse. + + + Initialisiert eine neue Instanz der -Klasse, die über eine angegebene Fehlermeldung verfügt. + Die Meldung, in der die Ausnahme beschrieben wirdDer Aufrufer dieses Konstruktors muss sicherstellen, dass diese Zeichenfolge für die aktuelle Systemkultur lokalisiert wurde. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Fehlermeldung und einem Verweis auf die innere Ausnahme, die diese Ausnahme ausgelöst hat. + Die Fehlermeldung, in der die Ursache der Ausnahme erklärt wird. + Die Ausnahme, die die aktuelle Ausnahme ausgelöst hat, oder ein NULL-Verweis, wenn keine innere Ausnahme angegeben ist. + + + Stellt einen Fehler dar, der auftritt, wenn eine dynamische Bindung im C#-Laufzeitbinder verarbeitet wird. + + + Initialisiert eine neue Instanz der -Klasse mit einer vom System bereitgestellten Meldung, die den Fehler beschreibt. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Meldung, die den Fehler beschreibt. + Die Meldung, in der die Ausnahme beschrieben wirdDer Aufrufer dieses Konstruktors muss sicherstellen, dass diese Zeichenfolge für die aktuelle Systemkultur lokalisiert wurde. + + + Initialisiert eine neue Instanz der -Klasse mit einer angegebenen Fehlermeldung und einem Verweis auf die innere Ausnahme, die diese Ausnahme ausgelöst hat. + Die Fehlermeldung, in der die Ursache der Ausnahme erklärt wird. + Die Ausnahme, die die aktuelle Ausnahme ausgelöst hat, oder ein NULL-Verweis, wenn keine innere Ausnahme angegeben ist. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/es/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/es/Microsoft.CSharp.xml new file mode 100644 index 0000000..dc76977 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/es/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contiene métodos de generador que permiten crear enlazadores de sitios de llamada dinámicos para CSharp. + + + Inicializa un nuevo enlazador de operaciones binarias de CSharp. + Devuelve un nuevo enlazador de operaciones binarias de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo de operación binaria. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de conversiones de CSharp. + Devuelve un nuevo enlazador de conversiones de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo en el que se va a convertir. + Objeto que indica dónde se usa esta operación. + + + Inicializa un nuevo enlazador de operaciones de obtención de índice de CSharp. + Devuelve un nuevo enlazador de operaciones de obtención de índice de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones de obtención de miembro de CSharp. + Devuelve un nuevo enlazador de operaciones de obtención de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro que se va a obtener. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de CSharp. + Devuelve un nuevo enlazador de invocaciones de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de constructor de CSharp. + Devuelve un nuevo enlazador de invocaciones de constructor de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de invocaciones de miembro de CSharp. + Devuelve un nuevo enlazador de invocaciones de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro al que se va a invocar. + Lista de los argumentos de tipo especificados para esta invocación. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de búsquedas de eventos de CSharp. + Devuelve un nuevo enlazador de búsquedas de eventos de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del evento que se va a buscar. + Objeto que indica dónde se usa esta operación. + + + Inicializa un nuevo enlazador de operaciones de establecimiento de índice de CSharp. + Devuelve un nuevo enlazador de operaciones de establecimiento de índice de CSharp. + Marcas con las que se va a inicializar el enlazador. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones de establecimiento de miembro de CSharp. + Devuelve un nuevo enlazador de operaciones de establecimiento de miembro de CSharp. + Marcas con las que se va a inicializar el enlazador. + Nombre del miembro que se va a establecer. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Inicializa un nuevo enlazador de operaciones unarias de CSharp. + Devuelve un nuevo enlazador de operaciones unarias de CSharp. + Marcas con las que se va a inicializar el enlazador. + Tipo de operación unaria. + Objeto que indica dónde se usa esta operación. + Secuencia de instancias de para los argumentos de esta operación. + + + Representa información sobre las operaciones dinámicas de C# que son específicas de argumentos concretos en un lugar de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + Inicializa una nueva instancia de la clase . + Nueva instancia de la clase . + Marcas para el argumento. + Nombre del argumento, si lo tiene; de lo contrario, NULL. + + + Representa información sobre las operaciones dinámicas de C# que son específicas de argumentos concretos en un lugar de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + El argumento es una constante. + + + El argumento se pasa a un parámetro out. + + + El argumento se pasa a un parámetro ref. + + + El argumento es un objeto que indica un nombre de tipo real utilizado en origen.Únicamente se usa para los objetos de destino en las llamadas estáticas. + + + Es un argumento con nombre. + + + Ninguna información adicional para representar. + + + El tipo de tiempo de compilación del argumento debe considerarse durante el enlace. + + + Representa información sobre las operaciones dinámicas de C# que no son específicas de argumentos concretos en un sitio de llamada.Las instancias de esta clase se generan mediante el compilador de C#. + + + El enlazador representa un operador AND lógico u OR lógico que forma parte de una evaluación de operadores lógicos condicionales. + + + La evaluación de este enlazador se lleva a cabo en un contexto comprobado. + + + El enlazador representa una conversión implícita que se puede usar en una expresión de creación de matrices. + + + El enlazador representa una conversión explícita. + + + El enlazador representa una invocación en un nombre simple. + + + El enlazador representa una invocación en un nombre especial. + + + Este enlazador no requiere ninguna información adicional. + + + El enlazador se usa en una posición que no requiere un resultado y, por lo tanto, se puede enlazar a un método que devuelva void. + + + El resultado de cualquier enlace que se vaya a indizar obtiene un enlazador de índice set o de índice get. + + + El valor de este índice o miembro set se convierte en un operador de asignación compuesto. + + + Representa un error que se produce cuando se procesa un enlace dinámico en el enlazador en tiempo de ejecución de C#. + + + Inicializa una nueva instancia de la clase . + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado. + Mensaje que describe la excepción.El llamador de este constructor debe asegurarse de que esta cadena se ha traducido para la actual referencia cultural del sistema. + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado y una referencia a la excepción interna que representa la causa de esta excepción. + Mensaje de error que explica la razón de la excepción. + Excepción que es la causa de la excepción actual, o una referencia nula si no se especifica ninguna excepción interna. + + + Representa un error que se produce cuando se procesa un enlace dinámico en el enlazador en tiempo de ejecución de C#. + + + Inicializa una nueva instancia de la clase con un mensaje proporcionado por el sistema que describe el error. + + + Inicializa una nueva instancia de la clase con un mensaje de error especificado que describe el error. + Mensaje que describe la excepción.El llamador de este constructor debe asegurarse de que esta cadena se ha traducido para la actual referencia cultural del sistema. + + + Inicializa una nueva instancia de la clase que tiene un mensaje de error especificado y una referencia a la excepción interna que representa la causa de esta excepción. + Mensaje de error que explica la razón de la excepción. + Excepción que es la causa de la excepción actual, o una referencia nula si no se especifica ninguna excepción interna. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/fr/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/fr/Microsoft.CSharp.xml new file mode 100644 index 0000000..6ac8b3b --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/fr/Microsoft.CSharp.xml @@ -0,0 +1,201 @@ + + + + Microsoft.CSharp + + + + Contient des méthodes de fabrique pour créer des classeurs de sites d'appel dynamiques pour CSharp. + + + Initialise un nouveau classeur d'opérations binaires CSharp. + Retourne un nouveau classeur d'opérations binaires CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type d'opération binaire. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de conversion CSharp. + Retourne un nouveau classeur de conversion CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type dans lequel convertir. + + qui indique où cette opération est utilisée. + + + Initialise un nouveau classeur d'obtention d'index CSharp. + Retourne un nouveau classeur d'obtention d'index CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'obtention de membre CSharp. + Retourne un nouveau classeur d'obtention de membre CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à obtenir. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'appel CSharp. + Retourne un nouveau classeur d'appel CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de constructeurs appelés CSharp. + Retourne un nouveau classeur de constructeurs appelés CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de membres appelés CSharp. + Retourne un nouveau classeur de membres appelés CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à appeler. + Liste d'arguments de type spécifiés pour cet appel. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'événements CSharp. + Retourne un nouveau classeur d'événement CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom de l'événement à rechercher. + + qui indique où cette opération est utilisée. + + + Initialise un nouveau classeur de définition d'index CSharp. + Retourne un nouveau classeur de définition d'index CSharp. + Indicateurs avec lesquels initialiser le classeur. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur de définition de membre CSharp. + Retourne un nouveau classeur de définition de membre CSharp. + Indicateurs avec lesquels initialiser le classeur. + Nom du membre à définir. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Initialise un nouveau classeur d'opérations unaires CSharp. + Retourne un nouveau classeur d'opérations unaires CSharp. + Indicateurs avec lesquels initialiser le classeur. + Type d'opération unaire. + + qui indique où cette opération est utilisée. + Séquence d'instances pour les arguments de cette opération. + + + Représente les informations relatives aux opérations dynamiques en C# qui sont spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + Initialise une nouvelle instance de la classe . + Nouvelle instance de la classe . + Indicateurs de l'argument. + Nom de l'argument, s'il est nommé ; sinon, null. + + + Représente les informations relatives aux opérations dynamiques en C# qui sont spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + L'argument est une constante. + + + L'argument est passé à un paramètre de sortie (out). + + + L'argument est passé à un paramètre de référence (ref). + + + L'argument est un qui indique un nom de type réel utilisé dans la source.Utilisé uniquement pour les objets cible dans les appels statiques. + + + L'argument est un argument nommé. + + + Aucune information supplémentaire à représenter. + + + Le type de l'argument au moment de la compilation doit être considéré pendant la liaison. + + + Représente les informations relatives aux opérations dynamiques en C# qui ne sont pas spécifiques à des arguments particuliers sur un site d'appel.Les instances de cette classe sont générées par le compilateur C#. + + + Le classeur représente un AND logique ou un OR logique faisant partie d'une évaluation d'opérateur logique conditionnelle. + + + L'évaluation de ce classeur s'effectue dans un contexte vérifié (checked). + + + Le classeur représente une conversion implicite pour une utilisation dans une expression de création de tableau. + + + Le classeur représente une conversion explicite. + + + Le classeur représente un appel sur un nom simple. + + + Le classeur représente un appel sur un nom spécial. + + + Aucune information supplémentaire n'est requise pour ce classeur. + + + Le classeur est utilisé à un emplacement qui ne requiert pas de résultat et peut par conséquent créer une liaison avec une méthode retournant void. + + + Le résultat de n'importe quel lien sera un classeur indexé d'obtention d'index ou de membre défini. + + + La valeur dans cet index défini ou membre défini provient d'un opérateur d'assignation composée. + + + Représente une erreur qui se produit lorsqu'un lien dynamique dans le binder d'exécution C# est traité. + + + Initialise une nouvelle instance de la classe . + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié. + Message qui décrit l'exception.L'appelant de ce constructeur doit vérifier que cette chaîne a été localisée pour la culture du système en cours. + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié et une référence à l'exception interne à l'origine de cette exception. + Message d'erreur indiquant la raison de l'exception. + Exception à l'origine de l'exception actuelle, ou référence null si aucune exception interne n'est spécifiée. + + + Représente une erreur qui se produit lorsqu'un lien dynamique dans le binder d'exécution C# est traité. + + + Initialise une nouvelle instance de la classe avec un message système décrivant l'erreur. + + + Initialise une nouvelle instance de la classe avec un message spécifié décrivant l'erreur. + Message qui décrit l'exception.L'appelant de ce constructeur doit vérifier que cette chaîne a été localisée pour la culture du système en cours. + + + Initialise une nouvelle instance de la classe qui comporte un message d'erreur spécifié et une référence à l'exception interne à l'origine de cette exception. + Message d'erreur indiquant la raison de l'exception. + Exception à l'origine de l'exception actuelle, ou référence null si aucune exception interne n'est spécifiée. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/it/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/it/Microsoft.CSharp.xml new file mode 100644 index 0000000..e7621f3 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/it/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Contiene metodi factory per creare gestori di associazione del sito di chiamata dinamica per CSharp. + + + Inizializza un nuovo gestore di associazione dell'operazione binaria di CSharp. + Restituisce un nuovo gestore di associazione dell'operazione binaria di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo di operazione binaria. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione delle conversioni di CSharp. + Restituisce un nuovo gestore di associazione delle conversioni di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo in cui eseguire la conversione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + + + Inizializza un nuovo gestore di associazione dell'indice get di CSharp. + Restituisce un nuovo gestore di associazione dell'indice get di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro get di CSharp. + Restituisce un nuovo gestore di associazione del membro get di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da ottenere. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione invoke di CSharp. + Restituisce un nuovo gestore di associazione invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del costruttore invoke di CSharp. + Restituisce un nuovo gestore di associazione del costruttore invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro invoke di CSharp. + Restituisce un nuovo gestore di associazione del membro invoke di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da richiamare, + Elenco di argomenti del tipo specificati per la chiamata. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione degli eventi is di CSharp. + Restituisce un nuovo gestore di associazione degli eventi is di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome dell'evento di cui eseguire la ricerca. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + + + Inizializza un nuovo gestore di associazione dell'indice set di CSharp. + Restituisce un nuovo gestore di associazione dell'indice set di CSharp. + Flag con cui inizializzare il gestore di associazione. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione del membro set di CSharp. + Restituisce un nuovo gestore di associazione del membro set di CSharp. + Flag con cui inizializzare il gestore di associazione. + Nome del membro da impostare. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Inizializza un nuovo gestore di associazione dell'operazione unaria di CSharp. + Restituisce un nuovo gestore di associazione dell'operazione unaria di CSharp. + Flag con cui inizializzare il gestore di associazione. + Tipo di operazione unaria. + Oggetto che indica il contesto in cui viene utilizzata l'operazione. + Sequenza di istanze di per gli argomenti dell'operazione. + + + Rappresenta informazioni sulle operazioni dinamiche in C# specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + Inizializza una nuova istanza della classe . + Nuova istanza della classe . + Flag per l'argomento. + Nome dell'argomento, se denominato; in caso contrario, null. + + + Rappresenta informazioni sulle operazioni dinamiche in C# specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + L'argomento è una costante. + + + L'argomento viene passato a un parametro out. + + + L'argomento viene passato a un parametro ref. + + + L'argomento è un oggetto che indica un nome di tipo effettivo utilizzato nell'origine.Utilizzato solo per gli oggetti di destinazione in chiamate statiche. + + + L'argomento è un argomento denominato. + + + Nessuna informazione aggiuntiva da rappresentare. + + + Il tipo dell'argomento in fase di compilazione deve essere considerato durante l'associazione. + + + Rappresenta informazioni sulle operazioni dinamiche in C# non specifiche di determinati argomenti in un sito di chiamata.Istanze di questa classe vengono generate dal compilatore C#. + + + Il gestore di associazione rappresenta un operatore logico AND o OR che fa parte di una valutazione dell'operatore logico condizionale. + + + La valutazione di questo gestore di associazione si verifica in un contesto verificato. + + + Il gestore di associazione rappresenta una conversione implicita per l'utilizzo in un'espressione di creazione di una matrice. + + + Il gestore di associazione rappresenta una conversione esplicita. + + + Il gestore di associazione rappresenta una chiamata per un nome semplice. + + + Il gestore di associazione rappresenta una chiamata per uno SpecialName. + + + Non sono presenti informazioni aggiuntive necessarie per questo gestore di associazione. + + + Il gestore di associazione viene utilizzato in una posizione che non richiede un risultato e può quindi essere associato a un metodo che restituisce void. + + + Il risultato di qualsiasi associazione sarà indicizzato per ottenere un gestore di associazione dell'indice set o get. + + + Il valore in questo indice set o membro set presenta un operatore di assegnazione composto. + + + Rappresenta un errore che si verifica quando viene elaborata un'associazione dinamica nel gestore di associazione di runtime in C#. + + + Inizializza una nuova istanza della classe . + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato. + Messaggio in cui viene descritta l'eccezione.È necessario che il chiamante del costruttore assicuri che la stringa sia stata localizzata per le impostazioni cultura correnti del sistema. + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato e un riferimento all'eccezione interna che ha generato l'eccezione. + Messaggio di errore nel quale viene indicato il motivo dell’eccezione + Eccezione che ha provocato l'eccezione corrente o riferimento null se non è stata specificata alcuna eccezione interna. + + + Rappresenta un errore che si verifica quando viene elaborata un'associazione dinamica nel gestore di associazione di runtime in C#. + + + Inizializza una nuova istanza della classe con un messaggio fornito dal sistema in cui viene descritto l'errore. + + + Inizializza una nuova istanza della classe con un messaggio specifico in cui viene descritto l'errore. + Messaggio in cui viene descritta l'eccezione.È necessario che il chiamante del costruttore assicuri che la stringa sia stata localizzata per le impostazioni cultura correnti del sistema. + + + Inizializza una nuova istanza della classe che include un messaggio di errore specificato e un riferimento all'eccezione interna che ha generato l'eccezione. + Messaggio di errore nel quale viene indicato il motivo dell’eccezione + Eccezione che ha provocato l'eccezione corrente o riferimento null se non è stata specificata alcuna eccezione interna. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ja/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ja/Microsoft.CSharp.xml new file mode 100644 index 0000000..e1f883c --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ja/Microsoft.CSharp.xml @@ -0,0 +1,193 @@ + + + + Microsoft.CSharp + + + + CSharp の動的呼び出しサイト バインダーを作成するファクトリ メソッドが含まれています。 + + + CSharp の新しい二項演算バインダーを初期化します。 + CSharp の新しい二項演算バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 二項演算の種類。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい変換バインダーを初期化します。 + CSharp の新しい変換バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 変換後の型。 + この操作の使用場所を示す 。 + + + CSharp の新しいインデックス取得バインダーを初期化します。 + CSharp の新しいインデックス取得バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー取得バインダーを初期化します。 + CSharp の新しいメンバー取得バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 取得するメンバーの名前。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい呼び出しバインダーを初期化します。 + CSharp の新しい呼び出しバインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいコンストラクター バインダーを初期化します。 + CSharp の新しいコンストラクター バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー呼び出しバインダーを初期化します。 + CSharp の新しいメンバー呼び出しバインダーを返します。 + バインダーの初期化に使用するフラグ。 + 呼び出されるメンバーの名前。 + この呼び出しに対して指定する型引数のリスト。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいイベント確認バインダーを初期化します。 + CSharp の新しいイベント確認バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 検索するイベントの名前。 + この操作の使用場所を示す 。 + + + CSharp の新しいインデックス設定バインダーを初期化します。 + CSharp の新しいインデックス設定バインダーを返します。 + バインダーの初期化に使用するフラグ。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しいメンバー設定バインダーを初期化します。 + CSharp の新しいメンバー設定バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 設定するメンバーの名前。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + CSharp の新しい単項演算バインダーを初期化します。 + CSharp の新しい単項演算バインダーを返します。 + バインダーの初期化に使用するフラグ。 + 単項演算の種類。 + この操作の使用場所を示す 。 + この操作に対する引数の インスタンスのシーケンス。 + + + 呼び出しサイトにおける特定の引数に固有の、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + + クラスの新しいインスタンスを初期化します。 + + クラスの新しいインスタンス。 + 引数のフラグ。 + 引数に名前がある場合はその名前。それ以外の場合は null。 + + + 呼び出しサイトにおける特定の引数に固有の、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + 引数は定数です。 + + + 引数は out パラメーターに渡されます。 + + + 引数は ref パラメーターに渡されます。 + + + 引数は、ソースで使用されている実際の型名を示す です。静的呼び出しのターゲット オブジェクトでのみ使用されます。 + + + 引数は名前付き引数です。 + + + 追加情報はありません。 + + + 引数のコンパイル時の型はバインディング時に考慮されます。 + + + 呼び出しサイトにおける特定の引数に固有ではない、C# の動的操作に関する情報を表します。このクラスのインスタンスは、C# コンパイラによって生成されます。 + + + このバインダーは、条件論理演算子の評価の一部である論理 AND または論理 OR を表します。 + + + このバインダーの評価は、checked コンテキストで行われます。 + + + このバインダーは、配列作成式で使用する暗黙の型変換を表します。 + + + このバインダーは、明示的な変換を表します。 + + + このバインダーは、簡易名での呼び出しを表します。 + + + このバインダーは、特別な名前での呼び出しを表します。 + + + このバインダーに必要な追加情報はありません。 + + + バインダーは、結果を必要としない位置で使用されるため、戻り型が void のメソッドにバインドできます。 + + + どのバインドの結果にもインデックスが付けられます。インデックス設定バインダーまたはインデックス取得バインダーが必要です。 + + + このインデックス設定またはメンバー設定の値は複合代入演算子になります。 + + + C# ランタイム バインダーで動的バインドが処理されたときに発生するエラーを表します。 + + + + クラスの新しいインスタンスを初期化します。 + + + 指定したエラー メッセージを持つ、 クラスの新しいインスタンスを初期化します。 + 例外を説明するメッセージ。このコンストラクターの呼び出し元では、この文字列が現在のシステムのカルチャに合わせてローカライズ済みであることを確認しておく必要があります。 + + + 指定したエラー メッセージおよびこの例外の原因である内部例外への参照を持つ、 クラスの新しいインスタンスを初期化します。 + 例外の原因を説明するエラー メッセージ。 + 現在の例外の原因となった例外。内部例外が指定されていない場合は null 参照。 + + + C# ランタイム バインダーで動的バインドが処理されたときに発生するエラーを表します。 + + + エラーを説明するシステム提供のメッセージを使用して、 クラスの新しいインスタンスを初期化します。 + + + エラーを説明する指定したメッセージを使用して、 クラスの新しいインスタンスを初期化します。 + 例外を説明するメッセージ。このコンストラクターの呼び出し元では、この文字列が現在のシステムのカルチャに合わせてローカライズ済みであることを確認しておく必要があります。 + + + 指定したエラー メッセージおよびこの例外の原因である内部例外への参照を持つ、 クラスの新しいインスタンスを初期化します。 + 例外の原因を説明するエラー メッセージ。 + 現在の例外の原因となった例外。内部例外が指定されていない場合は null 参照。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ko/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ko/Microsoft.CSharp.xml new file mode 100644 index 0000000..2e64855 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ko/Microsoft.CSharp.xml @@ -0,0 +1,193 @@ + + + + Microsoft.CSharp + + + + CSharp의 동적 호출 사이트 바인더를 만드는 팩터리 메서드가 들어 있습니다. + + + 새 CSharp 이항 연산 바인더를 초기화합니다. + 새 CSharp 이항 연산 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이항 연산 종류입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 변환 바인더를 초기화합니다. + 새 CSharp 변환 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 변환할 대상 형식입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + + + 새 CSharp 인덱스 가져오기 바인더를 초기화합니다. + 새 CSharp 인덱스 가져오기 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 가져오기 바인더를 초기화합니다. + 새 CSharp 멤버 가져오기 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 가져올 멤버의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 호출 바인더를 초기화합니다. + 새 CSharp 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 생성자 호출 바인더를 초기화합니다. + 새 CSharp 생성자 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 호출 바인더를 초기화합니다. + 새 CSharp 멤버 호출 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 호출할 멤버의 이름입니다. + 이 호출에 대해 지정된 형식 인수의 목록입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 이벤트 확인 바인더를 초기화합니다. + 새 CSharp 이벤트 확인 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 찾을 이벤트의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + + + 새 CSharp 인덱스 설정 바인더를 초기화합니다. + 새 CSharp 인덱스 설정 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 멤버 설정 바인더를 초기화합니다. + 새 CSharp 멤버 설정 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 설정할 멤버의 이름입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 새 CSharp 단항 연산 바인더를 초기화합니다. + 새 CSharp 단항 연산 바인더를 반환합니다. + 바인더를 초기화하는 데 사용할 플래그입니다. + 단항 연산 종류입니다. + 이 작업이 사용된 위치를 나타내는 입니다. + 이 작업의 인수에 사용할 인스턴스의 시퀀스입니다. + + + 호출 사이트의 특정 인수와 관련된 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + + 클래스의 새 인스턴스를 초기화합니다. + + 클래스의 새 인스턴스입니다. + 인수의 플래그입니다. + 명명된 경우 인수의 이름이고, 그렇지 않으면 null입니다. + + + 호출 사이트의 특정 인수와 관련된 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + 인수가 상수입니다. + + + 인수가 out 매개 변수에 전달됩니다. + + + 인수가 ref 매개 변수에 전달됩니다. + + + 인수가 소스에서 사용된 실제 형식 이름을 나타내는 입니다.정적 호출의 대상 개체에만 사용됩니다. + + + 인수가 명명된 인수입니다. + + + 나타낼 추가 정보가 없습니다. + + + 바인딩하는 동안 인수의 컴파일 타임 형식을 고려해야 합니다. + + + 호출 사이트의 특정 인수와 관련되지 않은 C# 동적 작업에 대한 정보를 나타냅니다.이 클래스의 인스턴스는 C# 컴파일러에서 생성됩니다. + + + 바인더는 조건부 논리 연산자 계산에 속하는 논리적 AND 또는 논리적 OR를 나타냅니다. + + + 이 바인더에 대한 계산은 확인된 컨텍스트에서 발생합니다. + + + 바인더는 배열 생성 식에 사용할 암시적 변환을 나타냅니다. + + + 바인더는 명시적 변환을 나타냅니다. + + + 바인더는 단순한 이름에 대한 호출을 나타냅니다. + + + 바인더는 특수한 이름에 대한 호출을 나타냅니다. + + + 이 바인더에 필요한 추가 정보가 없습니다. + + + 바인더는 결과가 필요 없는 위치에서 사용되므로 void를 반환하는 메서드에 바인딩할 수 있습니다. + + + 바인딩의 결과가 인덱싱되어 인덱스 설정 또는 인덱스 가져오기 바인더를 가져옵니다. + + + 이 인덱스 설정 또는 멤버 설정의 값은 복합 할당 연산자에서 사용됩니다. + + + C# 런타임 바인더의 동적 바인드가 처리될 때 발생하는 오류를 나타냅니다. + + + + 클래스의 새 인스턴스를 초기화합니다. + + + 지정된 오류 메시지가 있는 클래스의 새 인스턴스를 초기화합니다. + 예외를 설명하는 메시지입니다.이 생성자의 호출자는 이 문자열이 현재 시스템 문화권에 맞게 지역화되었는지 확인하는 데 필요합니다. + + + 지정된 오류 메시지 및 해당 예외의 원인인 내부 예외에 대한 참조가 있는 클래스의 새 인스턴스를 초기화합니다. + 예외에 대한 이유를 설명하는 오류 메시지입니다. + 현재 예외의 원인인 예외 또는 내부 예외가 지정되지 않은 경우 null 참조입니다. + + + C# 런타임 바인더의 동적 바인드가 처리될 때 발생하는 오류를 나타냅니다. + + + 오류를 설명하는 시스템 제공 메시지를 사용하여 클래스의 새 인스턴스를 초기화합니다. + + + 오류를 설명하는 지정된 메시지를 사용하여 클래스의 새 인스턴스를 초기화합니다. + 예외를 설명하는 메시지입니다.이 생성자의 호출자는 이 문자열이 현재 시스템 문화권에 맞게 지역화되었는지 확인하는 데 필요합니다. + + + 지정된 오류 메시지와 이 예외의 원인인 내부 예외에 대한 참조를 갖는 클래스의 새 인스턴스를 초기화합니다. + 예외에 대한 이유를 설명하는 오류 메시지입니다. + 현재 예외의 원인인 예외 또는 내부 예외가 지정되지 않은 경우 null 참조입니다. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ru/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ru/Microsoft.CSharp.xml new file mode 100644 index 0000000..de8cf29 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/ru/Microsoft.CSharp.xml @@ -0,0 +1,190 @@ + + + + Microsoft.CSharp + + + + Содержит фабричные методы для создания динамических связывателей источников вызова для CSharp. + + + Инициализирует новый связыватель бинарной операции CSharp. + Возвращает новый связыватель бинарной операции CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Вид бинарной операции. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель преобразования CSharp. + Возвращает новый связыватель преобразования CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Тип, в который выполняется преобразование. + Объект , который указывает, где используется операция. + + + Инициализирует новый связыватель получения индекса CSharp. + Возвращает новый связыватель получения индекса CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель получения члена CSharp. + Возвращает новый связыватель получения члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя возвращаемого члена. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова CSharp. + Возвращает новый связыватель вызова CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова конструктора CSharp. + Возвращает новый связыватель вызова конструктора CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель вызова члена CSharp. + Возвращает новый связыватель вызова члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя элемента, который предполагается вызвать. + Список аргументов типа, указанных для данного вызова. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель поиска события CSharp. + Возвращает новый связыватель поиска события CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя искомого события. + Объект , который указывает, где используется операция. + + + Инициализирует новый связыватель задания индекса CSharp. + Возвращает новый связыватель задания индекса CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель задания члена CSharp. + Возвращает новый связыватель задания члена CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Имя задаваемого члена. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Инициализирует новый связыватель унарной операции CSharp. + Возвращает новый связыватель унарной операции CSharp. + Флаги, с помощью которых выполняется инициализация связывателя. + Вид унарной операции. + Объект , который указывает, где используется операция. + Последовательность экземпляров для аргументов данной операции. + + + Представляет сведения о динамических операциях C#, которые относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Инициализирует новый экземпляр класса . + Новый экземпляр класса . + Флаги для аргумента. + Имя аргумента, если ему присвоено имя, или NULL в противном случае. + + + Представляет сведения о динамических операциях C#, которые относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Аргумент является константой. + + + Аргумент, передаваемый в параметр out. + + + Аргумент, передаваемый в параметр ref. + + + Аргумент является объектом типа , указывающим фактическое имя типа, используемое в источнике.Используется только для целевых объектов в статических вызовах. + + + Аргумент является именованным аргументом. + + + Дополнительные сведения не представлены. + + + В процессе привязки следует учитывать тип времени компиляции аргумента. + + + Представляет сведения о динамических операциях C#, которые не относятся к определенным аргументам в источнике вызова.Экземпляры этого класса создаются компилятором C#. + + + Связыватель представляет логическое И или логическое ИЛИ, которое является частью оценки условного логического оператора. + + + Оценка данного связывателя происходит в проверяемом контексте. + + + Связыватель представляет неявное преобразование для использовании в выражении, создающем массив. + + + Связыватель представляет явное преобразование. + + + Связыватель представляет вызов по простому имени. + + + Связыватель представляет вызов по специальному имени. + + + Для данного связывателя не требуются дополнительные сведения. + + + Этот связыватель используется в позиции, не требующей результата, и, следовательно, может выполнять привязку к методу, возвращающему значение void. + + + Результатом любой привязки будет индексированный метод получения связывателя задания или получения индекса. + + + Значение данного метода задания индекса или члена становится частью составного оператора присваивания. + + + Представляет ошибку, которая происходит при обработке динамической привязки в связывателе среды выполнения C#. + + + Инициализирует новый экземпляр класса . + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке. + Сообщение с описанием исключения.Вызывающий оператор этого конструктора необходим, чтобы убедиться, локализована ли данная строка для текущего языка и региональных параметров системы. + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке и ссылку на внутреннее исключение, которое стало причиной данного исключения. + Сообщение об ошибке с объяснением причин исключения. + Исключение, вызвавшее текущее исключение, или пустая ссылка, если внутреннее исключение не задано. + + + Представляет ошибку, которая происходит при обработке динамической привязки в связывателе среды выполнения C#. + + + Инициализирует новый экземпляр класса системным сообщением, содержащим описание ошибки. + + + Инициализирует новый экземпляр класса заданным сообщением, содержащим описание ошибки. + Сообщение с описанием исключения.Вызывающий оператор этого конструктора необходим, чтобы убедиться, локализована ли данная строка для текущего языка и региональных параметров системы. + + + Инициализирует новый экземпляр класса , содержащий указанное сообщение об ошибке и ссылку на внутреннее исключение, которое стало причиной данного исключения. + Сообщение об ошибке с объяснением причин исключения. + Исключение, вызвавшее текущее исключение, или пустая ссылка, если внутреннее исключение не задано. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hans/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hans/Microsoft.CSharp.xml new file mode 100644 index 0000000..3b0aa98 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hans/Microsoft.CSharp.xml @@ -0,0 +1,191 @@ + + + + Microsoft.CSharp + + + + 包含用于为 CSharp 创建动态调用站点联编程序的工厂方法。 + + + 初始化新的 CSharp 二元运算联编程序。 + 返回新的 CSharp 二元运算联编程序。 + 用于初始化联编程序的标志。 + 二元运算类型。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 转换联编程序。 + 返回新的 CSharp 转换联编程序。 + 用于初始化联编程序的标志。 + 要转换到的类型。 + 用于指示此操作的使用位置的 。 + + + 初始化新的 CSharp 获取索引联编程序。 + 返回新的 CSharp 获取索引联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 获取成员联编程序。 + 返回新的 CSharp 获取成员联编程序。 + 用于初始化联编程序的标志。 + 要获取的成员名称。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用联编程序。 + 返回新的 CSharp 调用联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用构造函数联编程序。 + 返回新的 CSharp 调用构造函数联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 调用成员联编程序。 + 返回新的 CSharp 调用成员联编程序。 + 用于初始化联编程序的标志。 + 要调用的成员名。 + 为此调用指定的类型参数的列表。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 事件联编程序。 + 返回新的 CSharp 事件联编程序。 + 用于初始化联编程序的标志。 + 要查找的事件的名称。 + 用于指示此操作的使用位置的 。 + + + 初始化新的 CSharp 设置索引联编程序。 + 返回新的 CSharp 设置索引联编程序。 + 用于初始化联编程序的标志。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 设置成员联编程序。 + 返回新的 CSharp 设置成员联编程序。 + 用于初始化联编程序的标志。 + 要设置的成员的名称。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 初始化新的 CSharp 一元运算联编程序。 + 返回新的 CSharp 一元运算联编程序。 + 用于初始化联编程序的标志。 + 一元运算类型。 + 用于指示此操作的使用位置的 。 + 此操作的参数所用的 实例序列。 + + + 表示有关特定于调用站点上的特定参数的 C# 动态操作的信息。此类的实例由 C# 编译器生成。 + + + 初始化 类的新实例。 + + 类的新实例。 + 参数的标志。 + 如果已指定参数名称，则为相应的名称；否则为空。 + + + 表示有关特定于调用站点上的特定参数的 C# 动态操作的信息。此类的实例由 C# 编译器生成。 + + + 该参数是一个常量。 + + + 将实参传递到 out 形参。 + + + 将实参传递到 ref 形参。 + + + 参数为 ，它指示源中使用的实际类型名称。仅用于静态调用中的目标对象。 + + + 参数为命名参数。 + + + 没有要表示的附加信息。 + + + 在绑定期间，应考虑参数的编译时类型。 + + + 表示不特定于调用站点上特定参数的 C# 动态操作的相关信息。此类的实例由 C# 编译器生成。 + + + 此联编程序表示作为条件逻辑运算符计算的一部分的逻辑 AND 或逻辑 OR。 + + + 在已检查的上下文中计算此联编程序。 + + + 此联编程序表示要在数组创建表达式中使用的隐式转换。 + + + 此联编程序表示显式转换。 + + + 此联编程序表示对简单名称的调用。 + + + 此联编程序表示对特殊名称的调用。 + + + 此联编程序不需要附加信息。 + + + 联编程序在不需要结果的位置中使用，因此可绑定到一个 void 返回方法。 + + + 将为任何绑定的结果编制索引，以获得一个设置索引联编程序或获取索引联编程序。 + + + 此设置索引或设置成员中的值为复合赋值运算符。 + + + 表示在处理 C# 运行时联编程序中的动态绑定时发生的错误。 + + + 初始化 类的新实例。 + + + 初始化 类的新实例，它包含指定的错误消息。 + 描述该异常的消息。此构造函数的调用方需要确保此字符串已针对当前系统区域性进行了本地化。 + + + 初始化 类的新实例，该实例具有指定的错误消息以及对导致此异常的内部异常的引用。 + 解释异常原因的错误信息。 + 导致当前异常的异常；如果未指定内部异常，则为空引用。 + + + 表示在处理 C# 运行时联编程序中的动态绑定时发生的错误。 + + + 使用由系统提供的用来描述错误的消息初始化 类的新实例。 + + + 使用指定的描述错误的消息初始化 类的新实例。 + 描述该异常的消息。此构造函数的调用方需要确保此字符串已针对当前系统区域性进行了本地化。 + + + 初始化 类的新实例，该实例具有指定的错误消息以及对导致此异常的内部异常的引用。 + 解释异常原因的错误信息。 + 导致当前异常的异常；如果未指定内部异常，则为空引用。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hant/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hant/Microsoft.CSharp.xml new file mode 100644 index 0000000..043924f --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard1.0/zh-hant/Microsoft.CSharp.xml @@ -0,0 +1,211 @@ + + + + Microsoft.CSharp + + + + 包含建立 CSharp 動態呼叫位置繫結器的 Factory 方法。 + + + 初始化新的 CSharp 二進位運算繫結器。 + 傳回新的 CSharp 二進位運算繫結器。 + 用來初始化繫結器的旗標。 + 二元運算類型。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 轉換繫結器。 + 傳回新的 CSharp 轉換繫結器。 + 用來初始化繫結器的旗標。 + 要轉換成的型別。 + + ，指定在何處使用此作業。 + + + 初始化新的 CSharp get 索引繫結器。 + 傳回新的 CSharp get 索引繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp get 成員繫結器。 + 傳回新的 CSharp get 成員繫結器。 + 用來初始化繫結器的旗標。 + 要取得的成員名稱。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用繫結器。 + 傳回新的 CSharp 叫用繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用建構函式繫結器。 + 傳回新的 CSharp 叫用建構函式繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 叫用成員繫結器。 + 傳回新的 CSharp 叫用成員繫結器。 + 用來初始化繫結器的旗標。 + 要叫用的成員名稱。 + 為此叫用指定之型別引數的清單。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp Is 事件繫結器。 + 傳回新的 CSharp Is 事件繫結器。 + 用來初始化繫結器的旗標。 + 要尋找之事件的名稱。 + + ，指定在何處使用此作業。 + + + 初始化新的 CSharp set 索引繫結器。 + 傳回新的 CSharp set 索引繫結器。 + 用來初始化繫結器的旗標。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp set 成員繫結器。 + 傳回新的 CSharp set 成員繫結器。 + 用來初始化繫結器的旗標。 + 要設定之成員的名稱。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 初始化新的 CSharp 一元運算繫結器。 + 傳回新的 CSharp 一元運算繫結器。 + 用來初始化繫結器的旗標。 + 一元運算類型。 + + ，指定在何處使用此作業。 + + 執行個體的序列，做為這個運算的引數。 + + + 表示呼叫位置上特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 初始化 類別的新執行個體。 + + 類別的新執行個體。 + 引數的旗標。 + 如果是具名引數，則為引數的名稱，否則為 null。 + + + 表示呼叫位置上特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 引數為常數。 + + + 引數傳遞給 out 參數。 + + + 引數傳遞給 ref 參數。 + + + 引數為 ，表示來源中使用的實際型別名稱。只用於靜態呼叫中的目標物件。 + + + 引數為具名引數。 + + + 無其他要表示的資訊。 + + + 繫結期間應該考慮引數的編譯時期型別。 + + + 表示呼叫位置上非特定引數特有的 C# 動態運算的相關資訊。這個類別的執行個體會由 C# 編譯器產生。 + + + 繫結器表示邏輯 AND 或邏輯 OR，這些是條件邏輯運算子評估的一部分。 + + + 此繫結器的評估會在檢查的內容中進行。 + + + 繫結器表示陣列建立運算式中使用的隱含轉換。 + + + 繫結器表示明確轉換。 + + + 繫結器表示在簡單名稱上叫用。 + + + 繫結器表示在 Specialname 上叫用。 + + + 此繫結器不需要額外的資訊。 + + + 繫結器用於不需要結果的位置，因此可以繫結至傳回 Void 的方法。 + + + 任何繫結的結果都會變成索引的 get 索引或 set 索引，或 get 索引繫結器。 + + + 此 set 索引或 set 成員中的值為複合指派運算子。 + + + 表示在處理 C# 執行階段繫結器中的動態繫結時所發生的錯誤。 + + + 初始化 類別的新執行個體。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息。 + 說明例外狀況的訊息。這個建構函式的呼叫端必須確保這個字串已經為目前系統的文化特性當地語系化。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息和造成這個例外狀況發生之內部例外狀況的參考。 + 解釋例外狀況原因的錯誤訊息。 + 導致目前例外狀況發生的例外狀況，如果沒有指定內部例外狀況則為 null 參考。 + + + 表示在處理 C# 執行階段繫結器中的動態繫結時所發生的錯誤。 + + + 以系統提供的錯誤說明訊息，初始化 類別的新執行個體。 + + + 使用指定的錯誤說明訊息，初始化 類別的新執行個體。 + 說明例外狀況的訊息。這個建構函式的呼叫端必須確保這個字串已經為目前系統的文化特性當地語系化。 + + + 初始化 類別的新執行個體，這個執行個體有指定的錯誤訊息和造成這個例外狀況發生之內部例外狀況的參考。 + 解釋例外狀況原因的錯誤訊息。 + 導致目前例外狀況發生的例外狀況，如果沒有指定內部例外狀況則為 null 參考。 + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.dll b/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.dll new file mode 100644 index 0000000..f85bffd Binary files /dev/null and b/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.dll differ diff --git a/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.xml b/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.xml new file mode 100644 index 0000000..adf05ce --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/ref/netstandard2.0/Microsoft.CSharp.xml @@ -0,0 +1,200 @@ + + + + Microsoft.CSharp + + + + Contains factory methods to create dynamic call site binders for CSharp. + + + Initializes a new CSharp binary operation binder. + The flags with which to initialize the binder. + The binary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp binary operation binder. + + + Initializes a new CSharp convert binder. + The flags with which to initialize the binder. + The type to convert to. + The that indicates where this operation is used. + A new CSharp convert binder. + + + Initializes a new CSharp get index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp get index binder. + + + Initializes a new CSharp get member binder. + The flags with which to initialize the binder. + The name of the member to get. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp get member binder. + + + Initializes a new CSharp invoke binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke binder. + + + Initializes a new CSharp invoke constructor binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke constructor binder. + + + Initializes a new CSharp invoke member binder. + The flags with which to initialize the binder. + The name of the member to invoke. + The list of type arguments specified for this invoke. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp invoke member binder. + + + Initializes a new CSharp is event binder. + The flags with which to initialize the binder. + The name of the event to look for. + The that indicates where this operation is used. + A new CSharp is event binder. + + + Initializes a new CSharp set index binder. + The flags with which to initialize the binder. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp set index binder. + + + Initializes a new CSharp set member binder. + The flags with which to initialize the binder. + The name of the member to set. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp set member binder. + + + Initializes a new CSharp unary operation binder. + The flags with which to initialize the binder. + The unary operation kind. + The that indicates where this operation is used. + The sequence of instances for the arguments to this operation. + A new CSharp unary operation binder. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + Initializes a new instance of the class. + The flags for the argument. + The name of the argument, if named; otherwise null. + A new instance of the class. + + + Represents information about C# dynamic operations that are specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The argument is a constant. + + + The argument is passed to an out parameter. + + + The argument is passed to a ref parameter. + + + The argument is a indicating an actual type name used in source. Used only for target objects in static calls. + + + The argument is a named argument. + + + No additional information to represent. + + + The argument's compile-time type should be considered during binding. + + + Represents information about C# dynamic operations that are not specific to particular arguments at a call site. Instances of this class are generated by the C# compiler. + + + The binder represents a logical AND or logical OR that is part of a conditional logical operator evaluation. + + + The evaluation of this binder happens in a checked context. + + + The binder represents an implicit conversion for use in an array creation expression. + + + The binder represents an explicit conversion. + + + The binder represents an invoke on a simple name. + + + The binder represents an invoke on a specialname. + + + There is no additional information required for this binder. + + + The binder is used in a position that does not require a result, and can therefore bind to a void returning method. + + + The result of any bind is going to be indexed get a set index or get index binder. + + + The value in this set index or set member comes a compound assignment operator. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class. + + + Initializes a new instance of the class that has serialized data. + The object that holds the serialized object data about the exception being thrown. + The contextual information about the source or destination. + + + Initializes a new instance of the class that has a specified error message. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + Represents an error that occurs when a dynamic bind in the C# runtime binder is processed. + + + Initializes a new instance of the class with a system-supplied message that describes the error. + + + Initializes a new instance of the class with serialized data. + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class with a specified message that describes the error. + The message that describes the exception. The caller of this constructor is required to ensure that this string has been localized for the current system culture. + + + Initializes a new instance of the class that has a specified error message and a reference to the inner exception that is the cause of this exception. + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference if no inner exception is specified. + + + \ No newline at end of file diff --git a/packages/Microsoft.CSharp.4.7.0/ref/portable-net45+win8+wp8+wpa81/_._ b/packages/Microsoft.CSharp.4.7.0/ref/portable-net45+win8+wp8+wpa81/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/uap10.0.16299/_._ b/packages/Microsoft.CSharp.4.7.0/ref/uap10.0.16299/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/win8/_._ b/packages/Microsoft.CSharp.4.7.0/ref/win8/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/wp80/_._ b/packages/Microsoft.CSharp.4.7.0/ref/wp80/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/wpa81/_._ b/packages/Microsoft.CSharp.4.7.0/ref/wpa81/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/xamarinios10/_._ b/packages/Microsoft.CSharp.4.7.0/ref/xamarinios10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/xamarinmac20/_._ b/packages/Microsoft.CSharp.4.7.0/ref/xamarinmac20/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/xamarintvos10/_._ b/packages/Microsoft.CSharp.4.7.0/ref/xamarintvos10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/ref/xamarinwatchos10/_._ b/packages/Microsoft.CSharp.4.7.0/ref/xamarinwatchos10/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/useSharedDesignerContext.txt b/packages/Microsoft.CSharp.4.7.0/useSharedDesignerContext.txt new file mode 100644 index 0000000..e69de29 diff --git a/packages/Microsoft.CSharp.4.7.0/version.txt b/packages/Microsoft.CSharp.4.7.0/version.txt new file mode 100644 index 0000000..f5d54e7 --- /dev/null +++ b/packages/Microsoft.CSharp.4.7.0/version.txt @@ -0,0 +1 @@ +0f7f38c4fd323b26da10cce95f857f77f0f09b48 diff --git a/packages/Newtonsoft.Json.13.0.3/.signature.p7s b/packages/Newtonsoft.Json.13.0.3/.signature.p7s new file mode 100644 index 0000000..d55e472 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/.signature.p7s differ diff --git a/packages/Newtonsoft.Json.13.0.3/LICENSE.md b/packages/Newtonsoft.Json.13.0.3/LICENSE.md new file mode 100644 index 0000000..dfaadbe --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/LICENSE.md @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2007 James Newton-King + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/Newtonsoft.Json.13.0.3/Newtonsoft.Json.13.0.3.nupkg b/packages/Newtonsoft.Json.13.0.3/Newtonsoft.Json.13.0.3.nupkg new file mode 100644 index 0000000..5829e3d Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/Newtonsoft.Json.13.0.3.nupkg differ diff --git a/packages/Newtonsoft.Json.13.0.3/README.md b/packages/Newtonsoft.Json.13.0.3/README.md new file mode 100644 index 0000000..9982a45 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/README.md @@ -0,0 +1,71 @@ +# ![Logo](https://raw.githubusercontent.com/JamesNK/Newtonsoft.Json/master/Doc/icons/logo.jpg) Json.NET + +[![NuGet version (Newtonsoft.Json)](https://img.shields.io/nuget/v/Newtonsoft.Json.svg?style=flat-square)](https://www.nuget.org/packages/Newtonsoft.Json/) +[![Build status](https://dev.azure.com/jamesnk/Public/_apis/build/status/JamesNK.Newtonsoft.Json?branchName=master)](https://dev.azure.com/jamesnk/Public/_build/latest?definitionId=8) + +Json.NET is a popular high-performance JSON framework for .NET + +## Serialize JSON + +```csharp +Product product = new Product(); +product.Name = "Apple"; +product.Expiry = new DateTime(2008, 12, 28); +product.Sizes = new string[] { "Small" }; + +string json = JsonConvert.SerializeObject(product); +// { +// "Name": "Apple", +// "Expiry": "2008-12-28T00:00:00", +// "Sizes": [ +// "Small" +// ] +// } +``` + +## Deserialize JSON + +```csharp +string json = @"{ + 'Name': 'Bad Boys', + 'ReleaseDate': '1995-4-7T00:00:00', + 'Genres': [ + 'Action', + 'Comedy' + ] +}"; + +Movie m = JsonConvert.DeserializeObject(json); + +string name = m.Name; +// Bad Boys +``` + +## LINQ to JSON + +```csharp +JArray array = new JArray(); +array.Add("Manual text"); +array.Add(new DateTime(2000, 5, 23)); + +JObject o = new JObject(); +o["MyArray"] = array; + +string json = o.ToString(); +// { +// "MyArray": [ +// "Manual text", +// "2000-05-23T00:00:00" +// ] +// } +``` + +## Links + +- [Homepage](https://www.newtonsoft.com/json) +- [Documentation](https://www.newtonsoft.com/json/help) +- [NuGet Package](https://www.nuget.org/packages/Newtonsoft.Json) +- [Release Notes](https://github.com/JamesNK/Newtonsoft.Json/releases) +- [Contributing Guidelines](https://github.com/JamesNK/Newtonsoft.Json/blob/master/CONTRIBUTING.md) +- [License](https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md) +- [Stack Overflow](https://stackoverflow.com/questions/tagged/json.net) diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.dll new file mode 100644 index 0000000..9c0a335 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.xml new file mode 100644 index 0000000..bdc4622 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/net20/Newtonsoft.Json.xml @@ -0,0 +1,10393 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Represents a JSON property. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Provides a set of static (Shared in Visual Basic) methods for + querying objects that implement . + + + + + Returns the input typed as . + + + + + Returns an empty that has the + specified type argument. + + + + + Converts the elements of an to the + specified type. + + + + + Filters the elements of an based on a specified type. + + + + + Generates a sequence of integral numbers within a specified range. + + The value of the first integer in the sequence. + The number of sequential integers to generate. + + + + Generates a sequence that contains one repeated value. + + + + + Filters a sequence of values based on a predicate. + + + + + Filters a sequence of values based on a predicate. + Each element's index is used in the logic of the predicate function. + + + + + Projects each element of a sequence into a new form. + + + + + Projects each element of a sequence into a new form by + incorporating the element's index. + + + + + Projects each element of a sequence to an + and flattens the resulting sequences into one sequence. + + + + + Projects each element of a sequence to an , + and flattens the resulting sequences into one sequence. The + index of each source element is used in the projected form of + that element. + + + + + Projects each element of a sequence to an , + flattens the resulting sequences into one sequence, and invokes + a result selector function on each element therein. + + + + + Projects each element of a sequence to an , + flattens the resulting sequences into one sequence, and invokes + a result selector function on each element therein. The index of + each source element is used in the intermediate projected form + of that element. + + + + + Returns elements from a sequence as long as a specified condition is true. + + + + + Returns elements from a sequence as long as a specified condition is true. + The element's index is used in the logic of the predicate function. + + + + + Base implementation of First operator. + + + + + Returns the first element of a sequence. + + + + + Returns the first element in a sequence that satisfies a specified condition. + + + + + Returns the first element of a sequence, or a default value if + the sequence contains no elements. + + + + + Returns the first element of the sequence that satisfies a + condition or a default value if no such element is found. + + + + + Base implementation of Last operator. + + + + + Returns the last element of a sequence. + + + + + Returns the last element of a sequence that satisfies a + specified condition. + + + + + Returns the last element of a sequence, or a default value if + the sequence contains no elements. + + + + + Returns the last element of a sequence that satisfies a + condition or a default value if no such element is found. + + + + + Base implementation of Single operator. + + + + + Returns the only element of a sequence, and throws an exception + if there is not exactly one element in the sequence. + + + + + Returns the only element of a sequence that satisfies a + specified condition, and throws an exception if more than one + such element exists. + + + + + Returns the only element of a sequence, or a default value if + the sequence is empty; this method throws an exception if there + is more than one element in the sequence. + + + + + Returns the only element of a sequence that satisfies a + specified condition or a default value if no such element + exists; this method throws an exception if more than one element + satisfies the condition. + + + + + Returns the element at a specified index in a sequence. + + + + + Returns the element at a specified index in a sequence or a + default value if the index is out of range. + + + + + Inverts the order of the elements in a sequence. + + + + + Returns a specified number of contiguous elements from the start + of a sequence. + + + + + Bypasses a specified number of elements in a sequence and then + returns the remaining elements. + + + + + Bypasses elements in a sequence as long as a specified condition + is true and then returns the remaining elements. + + + + + Bypasses elements in a sequence as long as a specified condition + is true and then returns the remaining elements. The element's + index is used in the logic of the predicate function. + + + + + Returns the number of elements in a sequence. + + + + + Returns a number that represents how many elements in the + specified sequence satisfy a condition. + + + + + Returns a that represents the total number + of elements in a sequence. + + + + + Returns a that represents how many elements + in a sequence satisfy a condition. + + + + + Concatenates two sequences. + + + + + Creates a from an . + + + + + Creates an array from an . + + + + + Returns distinct elements from a sequence by using the default + equality comparer to compare values. + + + + + Returns distinct elements from a sequence by using a specified + to compare values. + + + + + Creates a from an + according to a specified key + selector function. + + + + + Creates a from an + according to a specified key + selector function and a key comparer. + + + + + Creates a from an + according to specified key + and element selector functions. + + + + + Creates a from an + according to a specified key + selector function, a comparer and an element selector function. + + + + + Groups the elements of a sequence according to a specified key + selector function. + + + + + Groups the elements of a sequence according to a specified key + selector function and compares the keys by using a specified + comparer. + + + + + Groups the elements of a sequence according to a specified key + selector function and projects the elements for each group by + using a specified function. + + + + + Groups the elements of a sequence according to a specified key + selector function and creates a result value from each group and + its key. + + + + + Groups the elements of a sequence according to a key selector + function. The keys are compared by using a comparer and each + group's elements are projected by using a specified function. + + + + + Groups the elements of a sequence according to a specified key + selector function and creates a result value from each group and + its key. The elements of each group are projected by using a + specified function. + + + + + Groups the elements of a sequence according to a specified key + selector function and creates a result value from each group and + its key. The keys are compared by using a specified comparer. + + + + + Groups the elements of a sequence according to a specified key + selector function and creates a result value from each group and + its key. Key values are compared by using a specified comparer, + and the elements of each group are projected by using a + specified function. + + + + + Applies an accumulator function over a sequence. + + + + + Applies an accumulator function over a sequence. The specified + seed value is used as the initial accumulator value. + + + + + Applies an accumulator function over a sequence. The specified + seed value is used as the initial accumulator value, and the + specified function is used to select the result value. + + + + + Produces the set union of two sequences by using the default + equality comparer. + + + + + Produces the set union of two sequences by using a specified + . + + + + + Returns the elements of the specified sequence or the type + parameter's default value in a singleton collection if the + sequence is empty. + + + + + Returns the elements of the specified sequence or the specified + value in a singleton collection if the sequence is empty. + + + + + Determines whether all elements of a sequence satisfy a condition. + + + + + Determines whether a sequence contains any elements. + + + + + Determines whether any element of a sequence satisfies a + condition. + + + + + Determines whether a sequence contains a specified element by + using the default equality comparer. + + + + + Determines whether a sequence contains a specified element by + using a specified . + + + + + Determines whether two sequences are equal by comparing the + elements by using the default equality comparer for their type. + + + + + Determines whether two sequences are equal by comparing their + elements by using a specified . + + + + + Base implementation for Min/Max operator. + + + + + Base implementation for Min/Max operator for nullable types. + + + + + Returns the minimum value in a generic sequence. + + + + + Invokes a transform function on each element of a generic + sequence and returns the minimum resulting value. + + + + + Returns the maximum value in a generic sequence. + + + + + Invokes a transform function on each element of a generic + sequence and returns the maximum resulting value. + + + + + Makes an enumerator seen as enumerable once more. + + + The supplied enumerator must have been started. The first element + returned is the element the enumerator was on when passed in. + DO NOT use this method if the caller must be a generator. It is + mostly safe among aggregate operations. + + + + + Sorts the elements of a sequence in ascending order according to a key. + + + + + Sorts the elements of a sequence in ascending order by using a + specified comparer. + + + + + Sorts the elements of a sequence in descending order according to a key. + + + + + Sorts the elements of a sequence in descending order by using a + specified comparer. + + + + + Performs a subsequent ordering of the elements in a sequence in + ascending order according to a key. + + + + + Performs a subsequent ordering of the elements in a sequence in + ascending order by using a specified comparer. + + + + + Performs a subsequent ordering of the elements in a sequence in + descending order, according to a key. + + + + + Performs a subsequent ordering of the elements in a sequence in + descending order by using a specified comparer. + + + + + Base implementation for Intersect and Except operators. + + + + + Produces the set intersection of two sequences by using the + default equality comparer to compare values. + + + + + Produces the set intersection of two sequences by using the + specified to compare values. + + + + + Produces the set difference of two sequences by using the + default equality comparer to compare values. + + + + + Produces the set difference of two sequences by using the + specified to compare values. + + + + + Creates a from an + according to a specified key + selector function. + + + + + Creates a from an + according to a specified key + selector function and key comparer. + + + + + Creates a from an + according to specified key + selector and element selector functions. + + + + + Creates a from an + according to a specified key + selector function, a comparer, and an element selector function. + + + + + Correlates the elements of two sequences based on matching keys. + The default equality comparer is used to compare keys. + + + + + Correlates the elements of two sequences based on matching keys. + The default equality comparer is used to compare keys. A + specified is used to compare keys. + + + + + Correlates the elements of two sequences based on equality of + keys and groups the results. The default equality comparer is + used to compare keys. + + + + + Correlates the elements of two sequences based on equality of + keys and groups the results. The default equality comparer is + used to compare keys. A specified + is used to compare keys. + + + + + Computes the sum of a sequence of values. + + + + + Computes the sum of a sequence of + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of values. + + + + + Computes the average of a sequence of values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of nullable + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of nullable values. + + + + + Computes the average of a sequence of nullable values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Returns the minimum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the minimum nullable value. + + + + + Returns the maximum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the maximum nullable value. + + + + + Computes the sum of a sequence of values. + + + + + Computes the sum of a sequence of + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of values. + + + + + Computes the average of a sequence of values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of nullable + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of nullable values. + + + + + Computes the average of a sequence of nullable values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Returns the minimum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the minimum nullable value. + + + + + Returns the maximum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the maximum nullable value. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of values. + + + + + Computes the average of a sequence of values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of nullable + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of nullable values. + + + + + Computes the average of a sequence of nullable values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Returns the minimum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the minimum nullable value. + + + + + Returns the maximum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the maximum nullable value. + + + + + Computes the sum of a sequence of values. + + + + + Computes the sum of a sequence of + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of values. + + + + + Computes the average of a sequence of values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of nullable + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of nullable values. + + + + + Computes the average of a sequence of nullable values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Returns the minimum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the minimum nullable value. + + + + + Returns the maximum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the maximum nullable value. + + + + + Computes the sum of a sequence of values. + + + + + Computes the sum of a sequence of + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of values. + + + + + Computes the average of a sequence of values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Computes the sum of a sequence of nullable values. + + + + + Computes the sum of a sequence of nullable + values that are obtained by invoking a transform function on + each element of the input sequence. + + + + + Computes the average of a sequence of nullable values. + + + + + Computes the average of a sequence of nullable values + that are obtained by invoking a transform function on each + element of the input sequence. + + + + + Returns the minimum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the minimum nullable value. + + + + + Returns the maximum value in a sequence of nullable + values. + + + + + Invokes a transform function on each element of a sequence and + returns the maximum nullable value. + + + + + Represents a collection of objects that have a common key. + + + + + Gets the key of the . + + + + + Defines an indexer, size property, and Boolean search method for + data structures that map keys to + sequences of values. + + + + + Represents a sorted sequence. + + + + + Performs a subsequent ordering on the elements of an + according to a key. + + + + + Represents a collection of keys each mapped to one or more values. + + + + + Gets the number of key/value collection pairs in the . + + + + + Gets the collection of values indexed by the specified key. + + + + + Determines whether a specified key is in the . + + + + + Applies a transform function to each key and its associated + values and returns the results. + + + + + Returns a generic enumerator that iterates through the . + + + + + See issue #11 + for why this method is needed and cannot be expressed as a + lambda at the call site. + + + + + See issue #11 + for why this method is needed and cannot be expressed as a + lambda at the call site. + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + + This attribute allows us to define extension methods without + requiring .NET Framework 3.5. For more information, see the section, + Extension Methods in .NET Framework 2.0 Apps, + of Basic Instincts: Extension Methods + column in MSDN Magazine, + issue Nov 2007. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.dll new file mode 100644 index 0000000..cd6d483 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.xml new file mode 100644 index 0000000..1934448 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/net35/Newtonsoft.Json.xml @@ -0,0 +1,9541 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Represents a JSON property. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.dll new file mode 100644 index 0000000..be3857e Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.xml new file mode 100644 index 0000000..a806363 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/net40/Newtonsoft.Json.xml @@ -0,0 +1,9741 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.dll new file mode 100644 index 0000000..341d08f Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.xml new file mode 100644 index 0000000..2c981ab --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/net45/Newtonsoft.Json.xml @@ -0,0 +1,11363 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.dll new file mode 100644 index 0000000..d035c38 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.xml new file mode 100644 index 0000000..6e3a52b --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/net6.0/Newtonsoft.Json.xml @@ -0,0 +1,11325 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.dll new file mode 100644 index 0000000..a0b1ff0 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.xml new file mode 100644 index 0000000..4409234 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.0/Newtonsoft.Json.xml @@ -0,0 +1,11051 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Allows users to control class loading and mandate what class to load. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Specifies what messages to output for the class. + + + + + Output no tracing and debugging messages. + + + + + Output error-handling messages. + + + + + Output warnings and error-handling messages. + + + + + Output informational messages, warnings, and error-handling messages. + + + + + Output all debugging and tracing messages. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + List of primitive types which can be widened. + + + + + Widening masks for primitive types above. + Index of the value in this array defines a type we're widening, + while the bits in mask define types it can be widened to (including itself). + + For example, value at index 0 defines a bool type, and it only has bit 0 set, + i.e. bool values can be assigned only to bool. + + + + + Checks if value of primitive type can be + assigned to parameter of primitive type . + + Source primitive type. + Target primitive type. + true if source type can be widened to target type, false otherwise. + + + + Checks if a set of values with given can be used + to invoke a method with specified . + + Method parameters. + Argument types. + Try to pack extra arguments into the last parameter when it is marked up with . + true if method can be called with given arguments, false otherwise. + + + + Compares two sets of parameters to determine + which one suits better for given argument types. + + + + + Returns a best method overload for given argument . + + List of method candidates. + Argument types. + Best method overload, or null if none matched. + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.dll new file mode 100644 index 0000000..b683225 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.xml new file mode 100644 index 0000000..4de49a7 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/netstandard1.3/Newtonsoft.Json.xml @@ -0,0 +1,11173 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Allows users to control class loading and mandate what class to load. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Specifies what messages to output for the class. + + + + + Output no tracing and debugging messages. + + + + + Output error-handling messages. + + + + + Output warnings and error-handling messages. + + + + + Output informational messages, warnings, and error-handling messages. + + + + + Output all debugging and tracing messages. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + List of primitive types which can be widened. + + + + + Widening masks for primitive types above. + Index of the value in this array defines a type we're widening, + while the bits in mask define types it can be widened to (including itself). + + For example, value at index 0 defines a bool type, and it only has bit 0 set, + i.e. bool values can be assigned only to bool. + + + + + Checks if value of primitive type can be + assigned to parameter of primitive type . + + Source primitive type. + Target primitive type. + true if source type can be widened to target type, false otherwise. + + + + Checks if a set of values with given can be used + to invoke a method with specified . + + Method parameters. + Argument types. + Try to pack extra arguments into the last parameter when it is marked up with . + true if method can be called with given arguments, false otherwise. + + + + Compares two sets of parameters to determine + which one suits better for given argument types. + + + + + Returns a best method overload for given argument . + + List of method candidates. + Argument types. + Best method overload, or null if none matched. + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.dll new file mode 100644 index 0000000..3af21d5 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.dll differ diff --git a/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.xml new file mode 100644 index 0000000..3357dd6 --- /dev/null +++ b/packages/Newtonsoft.Json.13.0.3/lib/netstandard2.0/Newtonsoft.Json.xml @@ -0,0 +1,11338 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. + + + + + Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The containing the BSON data to read. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The to write to. + + + + Initializes a new instance of the class. + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Creates a custom object. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + The default value is false. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets the naming strategy used to resolve how enum text is written. + + The naming strategy used to resolve how enum text is written. + + + + Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. + The default value is true. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Initializes a new instance of the class. + + The naming strategy used to resolve how enum text is written. + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + + Initializes a new instance of the class. + + The of the used to write enum text. + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + true if integers are allowed when serializing and deserializing; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from Unix epoch time + + + + + Gets or sets a value indicating whether the dates before Unix epoch + should converted to and from JSON. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + true to allow converting dates before Unix epoch to and from JSON; + false to throw an exception when a date being converted to or from JSON + occurred before Unix epoch. The default value is false. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. + + The name of the deserialized root element. + + + + Gets or sets a value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attribute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Gets or sets a value indicating whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + true if special characters are encoded; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + The default JSON name table implementation. + + + + + Initializes a new instance of the class. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Adds the specified string into name table. + + The string to add. + This method is not thread-safe. + The resolved string. + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that it is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and set members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent an array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, when returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, when returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items. + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between .NET types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output should be formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output should be formatted. + A collection of converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output should be formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + A JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be inferred from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Serializes the to a JSON string. + + The node to serialize. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to serialize. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the . + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output should be formatted. + A JSON string of the . + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output should be formatted. + Omits writing the root object. + A JSON string of the . + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by + and writes a Json.NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized . + + + + Deserializes the from a JSON string nested in a root element specified by , + writes a Json.NET array attribute for collections, and encodes special characters. + + The JSON string. + The name of the root element to append when deserializing. + + A value to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + + A value to indicate whether to encode special characters when converting JSON to XML. + If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify + XML namespaces, attributes or processing directives. Instead special characters are encoded and written + as part of the XML element name. + + The deserialized . + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Converts an object to and from JSON. + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. If there is no existing value then null will be used. + The existing value has a value. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Base class for a table of atomized string objects. + + + + + Gets a string containing the same characters as the specified range of characters in the given array. + + The character array containing the name to find. + The zero-based index into the array specifying the first character of the name. + The number of characters in the name. + A string containing the same characters as the specified range of characters in the given array. + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the type used when serializing the property's collection items. + + The collection's items type. + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by . + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously skips the children of the current token. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Specifies the state of the reader. + + + + + A read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader is in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the source should be closed when this reader is closed. + + + true to close the source when this reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. + The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Gets or sets how time zones are handled when reading JSON. + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Gets or sets how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets the .NET type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Reads the next JSON token from the source. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the source as a of . + + A of . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the current token and value. + + The new token. + The value. + A flag indicating whether the position index inside an array should be updated. + + + + Sets the state based on current token type. + + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the reader's state to . + If is set to true, the source is also closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Instructs the to always serialize the member, and to require that the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The line number indicating where the error occurred. + The line position indicating where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + The default value is . + + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + The default value is false. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to read values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifying the type is optional. + + + + + Serializes the specified and writes the JSON structure + using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) are handled. + The default value is . + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + The default value is . + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + The default value is . + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + The default value is . + + Null value handling. + + + + Gets or sets how default values are handled during serialization and deserialization. + The default value is . + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + The default value is . + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + The default value is . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + The default value is . + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + The default value is . + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + The default value is . + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Gets or sets how and values are formatted when writing JSON text, + and the expected date format when reading JSON text. + The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + A null value means there is no maximum. + The default value is 64. + + + + + Indicates how JSON text output is formatted. + The default value is . + + + + + Gets or sets how dates are written to JSON text. + The default value is . + + + + + Gets or sets how time zones are handled during serialization and deserialization. + The default value is . + + + + + Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + The default value is . + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written as JSON. + The default value is . + + + + + Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + The default value is . + + + + + Gets or sets how strings are escaped when writing JSON text. + The default value is . + + + + + Gets or sets the culture used when reading JSON. + The default value is . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + The default value is false. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + using values copied from the passed in . + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Asynchronously reads the next JSON token from the source. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns true if the next token was read successfully; false if there are no more tokens to read. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a []. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the []. This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a of . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the of . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously reads the next JSON token from the source as a . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous read. The + property returns the . This result will be null at the end of an array. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Initializes a new instance of the class with the specified . + + The containing the JSON data to read. + + + + Gets or sets the reader's property name table. + + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a []. + + A [] or null if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if and can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + Derived classes must override this method to get asynchronous behaviour. Otherwise it will + execute synchronously, returning an already-completed task. + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many s to write for each level in the hierarchy when is set to . + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to . + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Initializes a new instance of the class using the specified . + + The to write to. + + + + Flushes whatever is in the buffer to the underlying and also flushes the underlying . + + + + + Closes this writer. + If is set to true, the underlying is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a read method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the .NET type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Changes the reader's state to . + If is set to true, the underlying is also closed. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a []. + + + A [] or null if the next JSON token is null. + + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . This method will return null at the end of an array. + + + + Reads the next JSON token from the underlying as a of . + + A of . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Asynchronously closes this writer. + If is set to true, the destination is also closed. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the specified end token. + + The end token to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes indent characters. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the JSON value delimiter. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an indent space. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON without changing the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of the current JSON object or array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of an array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a constructor. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the end of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a null value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON array. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the start of a constructor with the given name. + + The name of the constructor. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the beginning of a JSON object. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a [] value. + + The [] value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a value. + + The value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes a of value. + + The of value to write. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes an undefined value. + + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously writes the given white space. + + The string of white space characters. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Asynchronously ets the state of the . + + The being written. + The value being written. + The token to monitor for cancellation requests. The default value is . + A that represents the asynchronous operation. + The default behaviour is to execute synchronously, returning an already-completed task. Derived + classes can override this behaviour for true asynchronicity. + + + + Gets or sets a value indicating whether the destination should be closed when this writer is closed. + + + true to close the destination when this writer is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. + + + true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Gets or sets how dates are written to JSON text. + + + + + Gets or sets how time zones are handled when writing JSON text. + + + + + Gets or sets how strings are escaped when writing JSON text. + + + + + Gets or sets how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Gets or sets how and values are formatted when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the destination and also flushes the destination. + + + + + Closes this writer. + If is set to true, the destination is also closed. + If is set to true, the JSON is auto-completed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair of a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + null can be passed to the method for tokens that don't have a value, e.g. . + + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a of value. + + The of value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the . + + The being written. + The value being written. + + + + The exception thrown when an error occurs while writing JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Initializes a new instance of the class + with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The path to the JSON where the error occurred. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how duplicate property names are handled when loading JSON. + + + + + Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. + + + + + Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. + + + + + Throw a when a duplicate property is encountered. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token. + + + + Gets the of with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous load. The property contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + + + + + Returns an enumerator that iterates through the collection. + + + A of that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + + + + Removes all items from the . + + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies the elements of the to an array, starting at a particular array index. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + + + + Represents a JSON constructor. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An of containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An of containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates a that can be used to add tokens to the . + + A that is ready to have content written to it. + + + + Replaces the child nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens. + + + + Represents a collection of objects. + + The type of token. + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Gets the of with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous load. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of of this object's properties. + + An of of this object's properties. + + + + Gets a with the specified name. + + The property name. + A with the specified name or null. + + + + Gets the with the specified name. + The exact name will be searched for first and if no matching property is found then + the will be used to match a property. + + The property name. + One of the enumeration values that specifies how the strings will be compared. + A matched with the specified name or null. + + + + Gets a of of this object's property values. + + A of of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + is not valid JSON. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + is not valid JSON. + + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object. + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Determines whether the JSON object has the specified property name. + + Name of the property. + true if the JSON object has the specified property name; otherwise, false. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries to get the with the specified property name. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that can be used to iterate through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Represents a JSON property. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Asynchronously loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns a that contains the JSON that was read from the specified . + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads a from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads a from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. + When the or + + methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Asynchronously creates an instance of with the content of the reader's current token. + + The reader. + The token to monitor for cancellation requests. The default value is . + A representing the asynchronous creation. The + property returns an instance of with the content of the reader's current token. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Specifies the settings used when cloning JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a flag that indicates whether to copy annotations when cloning a . + The default value is true. + + + A flag that indicates whether to copy annotations when cloning a . + + + + + Specifies the settings used when loading JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets how JSON comments are handled when loading JSON. + The default value is . + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + The default value is . + + The JSON line info handling. + + + + Gets or sets how duplicate property names in JSON objects are handled when loading JSON. + The default value is . + + The JSON duplicate property name handling. + + + + Specifies the settings used when merging JSON. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how null value properties are merged. + + How null value properties are merged. + + + + Gets or sets the comparison used to match property names while merging. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + The comparison used to match property names while merging. + + + + Specifies the settings used when selecting JSON. + + + + + Gets or sets a timeout that will be used when executing regular expressions. + + The timeout that will be used when executing regular expressions. + + + + Gets or sets a flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + A flag that indicates whether an error should be thrown if + no tokens are found when evaluating part of the expression. + + + + + Represents an abstract JSON token. + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Writes this token to a asynchronously. + + A into which this method will write. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains + the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Asynchronously creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + The token to monitor for cancellation requests. The default value is . + + A that represents the asynchronous creation. The + property returns a that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output should be formatted. + A collection of s which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to of . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from of to . + + The value to create a from. + The initialized with the specified value. + + + + Creates a for this token. + + A that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object. + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates an instance of the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + A positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + A positioned at the token to read into this . + + A that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A , or null. + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a using a JSONPath expression. Selects the token that matches the object path. + + + A that contains a JSONPath expression. + + The used to select tokens. + A . + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An of that contains the selected elements. + + + + Selects a collection of elements using a JSONPath expression. + + + A that contains a JSONPath expression. + + The used to select tokens. + An of that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A object to configure cloning settings. + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Initializes a new instance of the class. + + The token to read from. + The initial path of the token. It is prepended to the returned . + + + + Reads the next JSON token from the underlying . + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being written. + + The token being written. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying . + + + + + Closes this writer. + If is set to true, the JSON is auto-completed. + + + Setting to true has no additional effect, since the underlying is a type that cannot be closed. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will be raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Writes this token to a asynchronously. + + A into which this method will write. + The token to monitor for cancellation requests. + A collection of which will be used when writing the token. + A that represents the asynchronous write operation. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of s which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + ToString() returns a non-JSON string value for tokens with a type of . + If you want the JSON for all token types then you should use . + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not of the same type as this instance. + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read-only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisible by. + + A number that the value should be divisible by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). + + A flag indicating whether the value can not equal the number defined by the minimum attribute (). + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). + + A flag indicating whether the value can not equal the number defined by the maximum attribute (). + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallowed types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains JSON Schema. + + A that contains JSON Schema. + A populated from the string that contains JSON Schema. + + + + Load a from a string that contains JSON Schema using the specified . + + A that contains JSON Schema. + The resolver. + A populated from the string that contains JSON Schema. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or null if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. + + + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used by to resolve a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. + + + true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. + + + true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the name of the extension data. By default no changes are made to extension data names. + + Name of the extension data. + Resolved name of the extension data. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + Initializes a new instance of the class. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolve a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that was resolved from the reference. + + + + Gets the reference for the specified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Allows users to control class loading and mandate what class to load. + + + + + When implemented, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object + The type of the object the formatter creates a new instance of. + + + + When implemented, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets the internally resolved for the contract's type. + This converter is used as a fallback converter when no other converter is resolved. + Setting will always override this converter. + + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non-public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object constructor. + + The object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets the missing member handling used when deserializing this object. + + The missing member handling. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets or sets how the object's properties with null values are handled during serialization and deserialization. + + How the object's properties with null values are handled during serialization and deserialization. + + + + Gets the object's properties. + + The object's properties. + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Gets or sets the extension data name resolver. + + The extension data name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes precedence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets a value indicating whether has a value specified. + + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the type described by the argument. + + The type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + A kebab case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of will exclude messages and include , + and messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether extension data names should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specified. + The serialized property name. + + + + Gets the serialized name for a given extension data name. + + The initial extension data name. + The serialized extension data name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Hash code calculation + + + + + + Object equality implementation + + + + + + + Compare to another NamingStrategy + + + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + A flag indicating whether extension data names should be processed. + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Indicates the method that will be used during deserialization for locating and loading assemblies. + + + + + In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. + + + + + In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than . + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON + you must specify a root type object with + or . + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic . + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Helper class for serializing immutable collections. + Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed + https://github.com/JamesNK/Newtonsoft.Json/issues/652 + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike this class lets you reuse its internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls result in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + An array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + Specifies that an output will not be null even if the corresponding type allows it. + + + Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. + + + Initializes the attribute with the specified return value condition. + + The return value condition. If the method returns this value, the associated parameter will not be null. + + + + Gets the return value condition. + + + Specifies that an output may be null even if the corresponding type disallows it. + + + Specifies that null is allowed as an input even if the corresponding type disallows it. + + + + Specifies that the method will not return if the associated Boolean parameter is passed the specified value. + + + + + Initializes a new instance of the class. + + + The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + the associated parameter matches this value. + + + + Gets the condition parameter value. + + + diff --git a/packages/Newtonsoft.Json.13.0.3/packageIcon.png b/packages/Newtonsoft.Json.13.0.3/packageIcon.png new file mode 100644 index 0000000..10c06a5 Binary files /dev/null and b/packages/Newtonsoft.Json.13.0.3/packageIcon.png differ diff --git a/packages/System.Data.DataSetExtensions.4.5.0/.signature.p7s b/packages/System.Data.DataSetExtensions.4.5.0/.signature.p7s new file mode 100644 index 0000000..c2e8724 Binary files /dev/null and b/packages/System.Data.DataSetExtensions.4.5.0/.signature.p7s differ diff --git a/packages/System.Data.DataSetExtensions.4.5.0/LICENSE.TXT b/packages/System.Data.DataSetExtensions.4.5.0/LICENSE.TXT new file mode 100644 index 0000000..984713a --- /dev/null +++ b/packages/System.Data.DataSetExtensions.4.5.0/LICENSE.TXT @@ -0,0 +1,23 @@ +The MIT License (MIT) + +Copyright (c) .NET Foundation and Contributors + +All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/System.Data.DataSetExtensions.4.5.0/System.Data.DataSetExtensions.4.5.0.nupkg b/packages/System.Data.DataSetExtensions.4.5.0/System.Data.DataSetExtensions.4.5.0.nupkg new file mode 100644 index 0000000..1e8b165 Binary files /dev/null and b/packages/System.Data.DataSetExtensions.4.5.0/System.Data.DataSetExtensions.4.5.0.nupkg differ diff --git a/packages/System.Data.DataSetExtensions.4.5.0/THIRD-PARTY-NOTICES.TXT b/packages/System.Data.DataSetExtensions.4.5.0/THIRD-PARTY-NOTICES.TXT new file mode 100644 index 0000000..db542ca --- /dev/null +++ b/packages/System.Data.DataSetExtensions.4.5.0/THIRD-PARTY-NOTICES.TXT @@ -0,0 +1,309 @@ +.NET Core uses third-party libraries or other resources that may be +distributed under licenses different than the .NET Core software. + +In the event that we accidentally failed to list a required notice, please +bring it to our attention. Post an issue or email us: + + dotnet@microsoft.com + +The attached notices are provided for information only. + +License notice for Slicing-by-8 +------------------------------- + +http://sourceforge.net/projects/slicing-by-8/ + +Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved + + +This software program is licensed subject to the BSD License, available at +http://www.opensource.org/licenses/bsd-license.html. + + +License notice for Unicode data +------------------------------- + +http://www.unicode.org/copyright.html#License + +Copyright © 1991-2017 Unicode, Inc. All rights reserved. +Distributed under the Terms of Use in http://www.unicode.org/copyright.html. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Unicode data files and any associated documentation +(the "Data Files") or Unicode software and any associated documentation +(the "Software") to deal in the Data Files or Software +without restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, and/or sell copies of +the Data Files or Software, and to permit persons to whom the Data Files +or Software are furnished to do so, provided that either +(a) this copyright and permission notice appear with all copies +of the Data Files or Software, or +(b) this copyright and permission notice appear in associated +Documentation. + +THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT OF THIRD PARTY RIGHTS. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS +NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL +DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, +DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THE DATA FILES OR SOFTWARE. + +Except as contained in this notice, the name of a copyright holder +shall not be used in advertising or otherwise to promote the sale, +use or other dealings in these Data Files or Software without prior +written authorization of the copyright holder. + +License notice for Zlib +----------------------- + +https://github.com/madler/zlib +http://zlib.net/zlib_license.html + +/* zlib.h -- interface of the 'zlib' general purpose compression library + version 1.2.11, January 15th, 2017 + + Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + + Jean-loup Gailly Mark Adler + jloup@gzip.org madler@alumni.caltech.edu + +*/ + +License notice for Mono +------------------------------- + +http://www.mono-project.com/docs/about-mono/ + +Copyright (c) .NET Foundation Contributors + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the Software), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +License notice for International Organization for Standardization +----------------------------------------------------------------- + +Portions (C) International Organization for Standardization 1986: + Permission to copy in any form is granted for use with + conforming SGML systems and applications as defined in + ISO 8879, provided this notice is included in all copies. + +License notice for Intel +------------------------ + +"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation +and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +License notice for Xamarin and Novell +------------------------------------- + +Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Copyright (c) 2011 Novell, Inc (http://www.novell.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Third party notice for W3C +-------------------------- + +"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE +Status: This license takes effect 13 May, 2015. +This work is being provided by the copyright holders under the following license. +License +By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions. +Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications: +The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. +Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included. +Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)." +Disclaimers +THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. +COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT. +The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders." + +License notice for Bit Twiddling Hacks +-------------------------------------- + +Bit Twiddling Hacks + +By Sean Eron Anderson +seander@cs.stanford.edu + +Individually, the code snippets here are in the public domain (unless otherwise +noted) — feel free to use them however you please. The aggregate collection and +descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are +distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and +without even the implied warranty of merchantability or fitness for a particular +purpose. + +License notice for Brotli +-------------------------------------- + +Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +compress_fragment.c: +Copyright (c) 2011, Google Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +decode_fuzzer.c: +Copyright (c) 2015 The Chromium Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + diff --git a/packages/System.Data.DataSetExtensions.4.5.0/lib/net45/_._ b/packages/System.Data.DataSetExtensions.4.5.0/lib/net45/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/System.Data.DataSetExtensions.4.5.0/lib/netstandard2.0/System.Data.DataSetExtensions.dll b/packages/System.Data.DataSetExtensions.4.5.0/lib/netstandard2.0/System.Data.DataSetExtensions.dll new file mode 100644 index 0000000..5a1ad03 Binary files /dev/null and b/packages/System.Data.DataSetExtensions.4.5.0/lib/netstandard2.0/System.Data.DataSetExtensions.dll differ diff --git a/packages/System.Data.DataSetExtensions.4.5.0/ref/net45/_._ b/packages/System.Data.DataSetExtensions.4.5.0/ref/net45/_._ new file mode 100644 index 0000000..e69de29 diff --git a/packages/System.Data.DataSetExtensions.4.5.0/ref/netstandard2.0/System.Data.DataSetExtensions.dll b/packages/System.Data.DataSetExtensions.4.5.0/ref/netstandard2.0/System.Data.DataSetExtensions.dll new file mode 100644 index 0000000..7131df0 Binary files /dev/null and b/packages/System.Data.DataSetExtensions.4.5.0/ref/netstandard2.0/System.Data.DataSetExtensions.dll differ diff --git a/packages/System.Data.DataSetExtensions.4.5.0/useSharedDesignerContext.txt b/packages/System.Data.DataSetExtensions.4.5.0/useSharedDesignerContext.txt new file mode 100644 index 0000000..e69de29 diff --git a/packages/System.Data.DataSetExtensions.4.5.0/version.txt b/packages/System.Data.DataSetExtensions.4.5.0/version.txt new file mode 100644 index 0000000..47004a0 --- /dev/null +++ b/packages/System.Data.DataSetExtensions.4.5.0/version.txt @@ -0,0 +1 @@ +30ab651fcb4354552bd4891619a0bdd81e0ebdbf